This topic is under construction for the July 2020 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 ids for each sample. For options, see Samples: Generate Unique IDs
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
- Add a Sample Types web part, if you don't already have one.
- In the Sample Types web part, click New Sample Type.
- 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 Samples: Generate Unique IDs.
- Click the Fields panel to open it.
- Every sample type includes the fields "Name", "Description", and "Flag". You will not see those fields here, do not need to add them, and cannot change them.
- Name - Text (String) - (Required)
- Description - Text (String)
- Flag - Text (String)
- To add any additional fields, you can Infer fields from file if you have an example spreadsheet: Select or drag and drop a .csv, .tsv, .txt, .xls, or .xlsx file.
- If you don't have a file to infer from, manually define fields. You will also have the option to add more fields after inferring.
- Click Add Field for each additional field you need. Learn more about adding and editing fields
- Click Save when finished.
You will now see your sample type listed in the Sample Types