Assay data is captured in LabKey Biologics using "Assay Designs". Each Assay Design fields for capturing experimental results and metadata about them. 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|
The fields in an Assay Design are grouped into three categories:
- Data Fields - These fields capture the main results of your experiment, for example, see above.
- Run Fields - These are metadata fields that apply to one complete cycle of the experimental instrument or procedure. Possible run-level metadata fields would be: Operator (the lab technician who executed the experiment) or Instrument (the name of the lab instrument in which the experiment was performed).
- Batch Fields These metadata fields apply over a broader scope, i.e., to groups of runs. A possible batch-level metadata field would be: Project (the overall project to which the experiment contributes).
Create a New General Assay Design
To create a new assay in LabKey Biologics, do the following:
- On the Assays page, click Create > Assay Design.
- On the New Assay Design page:
- Select the assay type (this is like a template for your design). For most cases, select General.
- For Assay Location, retain the default value as Current Folder.
- Click Next.
- In the General Assay Designer:
- 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 Batch Fields panel. Remove the two default fields: ParticipantVisitResolver and TargetStudy. These two default fields are generally not useful in the context of LabKey Biologics. If desired, add your own batch-level metadata fields.
- Scroll down to the Run Fields panel. Add run-level metadata fields as desired.
- Scroll down to the Data Fields panel. Note that there are four default fields in this section. In most cases, remove ParticipantID and VisitID, as these fields are not typically used in LabKey Biologics.
- Click Add Field button to add new fields. Provide their Name, Label, and Type (= the data type).
- Keep adding fields until your data can be adequately captured.
- To create a link between the assay data and the original samples, we recommend adding a SampleID field of type "lookup". See below for details.
- Click Save and Close.
Linking Assay Data to Samples
To link assay data to the originating samples:
- In your Assay Design, add a field to the assay design, either in the Data Fields, Run, or Batch sections. This field can be of any name, such as SampleID or SpecimenID. Use whatever name best matches your result data. In the Type column, 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 SampleID field will lookup its values in another table, in this case a Sample Set.)
- To link to a specific Sample Set, for Schema select samples, and for Table select the desired Sample Set. In most cases, choose the (String) version of the table.
- To link to all samples across all Sample Sets, for Schema select exp, and for Table select Materials (Integer). (Note this is not the same as selecting the Schema "exp.materials".)
- Click Apply to confirm the lookup data type.
Linking Assay Data with Assay Requests
Import Data to the Assay Design