This topic is under construction for the 22.7 (July 2022) release of LabKey Server. For current documentation of this feature, click here.
A Sample Type is a group of samples accompanied by a suite of properties that describe shared characteristics of all samples in the group. Users must have administrator permissions (the Folder Admin role, or higher) to create new Sample Types or edit existing Sample Type designs.
Before you create a new sample type, consider how you will provide unique Sample IDs. For options, see Sample Naming Patterns
Decide also where you want the sample type to be available. If you define it in a given folder, it will be available only in that folder. Defined in a project, you will be able to add samples to it from the project itself and all subfolders of that project. If you define it in the Shared project
, it will be available site-wide.
Create A New Sample Type
Define Sample Properties
- Name: (Required) This is the name for the Sample Type itself, not to be confused with a "Name" column within the sample type providing unique sample names.
- Description: Optional description of the Sample Type itself. This is not to be confused with the "Description" column also available in the sample data.
- Naming Pattern: Every sample must have a unique name/id within the sample type. You can either provide these yourself in a "Name" column in your data, or ask the server to generate them using a naming pattern provided here. If you are providing names, leave the naming pattern field blank and ignore the placeholder text. Learn more about the options in the topic Sample Naming Patterns.
- Add Parent Alias: (Optional) If your imported data will include lineage/parentage information for your samples, provide the column name and Sample Type here. Learn more in this topic: Parent Samples: Derivation and Lineage.
- Auto-link Data to Study: (Optional) Select a study to which the data in this sample type should be linked. Learn more in this topic: Link Sample Data to Study.
- Linked Dataset Category: (Optional) Specify the desired category for the Sample Dataset that will be created (or appended to) in a target study when rows are linked. Learn more here: Manage Categories.
- Barcodes: (Optional) To enable auto-generation of barcodes for these samples, you will add a field of type Unique ID in the Fields section. Learn more in this topic: Barcode Fields.
Create Sample Fields
- Click the Fields panel to open it.
- Every sample type includes reserved fields, including "Name", "Description", and "Flag". You will not see those fields here, do not need to add them, and cannot change them.
- If you infer fields from a file, and it includes columns for reserved fields, they will not be shown as inferred. Reserved fields will always be created for you.
- To add any additional fields, you have several options:
- Import or infer fields from file: Select or drag and drop a file into the panel.
- If you don't have a file to use here, click Manually Define Fields.
- You will also have the option to add more fields after importing or inferring.
- Click Add Field for each additional field you need.
- Learn more about adding and editing fields in this topic: Field Editor
- Learn more about integrating Samples and Study data with Subject/Participant, VisitID, and VisitDate fields in this topic: Link Sample Data to Study
- Learn more about generating barcodes using Unique ID fields in this topic: Barcode Fields
- Click Save when finished.
You will now see your sample type listed in the Sample Types