Assay data is captured in LabKey Biologics by "Assay Designs". Each Assay Design is essentially a table, where each field has a name and data type, for example, the following Assay Design captures data from a Titration experiment.
|SampleID||Expression System||SampleDate||InjVol||Vial||Cal CurveID||Dilution||ResultID||MAb|
For an Assay Design to work with LabKey Biologics, it must meet the following requirements:
- The key field must be named "SampleID".
- The key field must of data type "lookup"
- The key field lookup must point to a table in the sample schema (or the exp.Materials table).
Having a sample ID column that is a lookup (to the materials table in general or a specific sample set) enables the link between assay data and the originating samples.
Create a New Assay
To create a new assay in LabKey Biologics, do the following:
- From the Assays page, click New Assay.
- Select the assay type (this is like a template for your design). For most cases, select General and click Next.
- In the General Assay Designer enter:
- Name field - this should reflect something about the nature of the assay and what is primarily being measured, for example, "Titer", "Immune Score", or "Cell Properties".
- Scroll down to the Data Fields area.
- Click Add Field button to add new fields. Provide their Name, Label, and Type (= the data type).
- Keep adding fields until you data can be adequately captured.
SpecimenID Field = A Lookup
The SpecimenID field get special treatment in LabKey Biologics -- it points to the originating sample or material that is being measured by the assay. The steps below establish a link between the Assay Design and the originating sample/material.
- For the SpecimenID field (already present by default in any General Assay Design), in the Type field, click the dropdown chevron.
- This brings up the Choose Field Type popup menu. Select lookup. (This is a linking data type. "Lookup" means that the SpecimenID will lookup its values in another table, in this case a Sample Set.)
- For Schema select samples.
- For Table select the appropriate Sample Set. In most cases, choose the (String) version of the table. The choice between (Integer) or (String) reflects the primary key of the underlying table. (ExpressionSystemSamples is shown below.)
- Click Apply to confirm the lookup data type.
Integration with Assay Requests
Finish the Assay Design
- When the fields are sufficiently defined, click Save and Close.
Import Data to the Assay Design
- Once you import data to the assay design, it will be shown in LabKey Biologics.