standardcurves
| Name | standardCurves.txt |
| JSON File Name | standardCurves.json |
| Type | combined |
| Schema Version | 3.37 |
| Description | The standard curve template defines and annotates the standard curves derived from the control sample's concentration and MFI to interpret the experiment sample's MFI in terms of its analyte concentration. This template requires that the standard curve be always new, while the experiment can be new or pre-defined. The standard curve is the key the template and must be unique. |
| Download | ⬇️ standardCurves.xlsx ⬇️ standardCurves.txt ⬇️ standardCurves.json This top-level schema references companion files (e.g. standardCurves.Datum.json) in the same json-templates folder — download the all_templates.zip to get them all together. |
Reading this table: see How to read the template documentation for what Required / Conditionally required / Optional mean and how to read the Type & Constraints column.
| Template Column | Requirement | Type & Constraints | Description |
|---|---|---|---|
| Standard Curve ID | Required | Text, max 100 characters JSON: standardCurveId (string) | The Standard Curve user defined ID is an identifier chosen by the data provider to refer to a Standard Curve. This ID may be referenced by other data records (e.g. MBAA results). The user defined ID is not shared. The identifier should be unique to the ImmPort workspace to which the data will be uploaded. |
| Formula | Conditionally required when you are defining a new Standard Curve in this row (rather than referencing an existing one) | Text, max 500 characters JSON: formula (string) | The formula used to calculate the standard curve from the input data. |
| Analyte Reported | Conditionally required when you are defining a new Standard Curve in this row (rather than referencing an existing one) | Text, max 100 characters Preferred vocabulary — reported value is kept; a preferred term from lk_analyte is filled in when it matches JSON: analyteReported (enum) | The molecule or entity being measured. Please select a name from the list provided if the name matches your name or enter a name if there is not an appropriate one provided. This name is visible when the result is shared. |
| Assay ID | Conditionally required when you are defining a new Standard Curve in this row (rather than referencing an existing one) | Text, max 100 characters JSON: assayId (string) | The assay ID represents the plate or array ID where standard curves, control samples, and experiment samples were collected and assayed. This ID will be used to link standard curves, control samples, and experiment samples results. |
| Assay Group ID | Optional | Text, max 100 characters JSON: assayGroupId (string) | The assay group ID represents a collection of plates or arrays. This ID may be used to link collections of standard curves, control samples, and experiment samples results. |
| Lower Limit | Conditionally required when you are defining a new Standard Curve in this row (rather than referencing an existing one) | Text, max 100 characters JSON: lowerLimit (string) | A number is expected. Lower limit value established by the standard curve. |
| Lower Limit Unit | Conditionally required when you are defining a new Standard Curve in this row (rather than referencing an existing one) | Text, max 100 characters JSON: lowerLimitUnit (string) | Lower limit unit established by the standard curve. |
| Upper Limit | Conditionally required when you are defining a new Standard Curve in this row (rather than referencing an existing one) | Text, max 100 characters JSON: upperLimit (string) | A number is expected. Upper limit value established by the standard curve. |
| Upper Limit Unit | Conditionally required when you are defining a new Standard Curve in this row (rather than referencing an existing one) | Text, max 100 characters JSON: upperLimitUnit (string) | Upper limit value established by the standard curve. |
| ImmPort Template? | Conditionally required when you are defining a new Standard Curve in this row (rather than referencing an existing one) | Controlled vocabulary — value must be one of lk_yes_no JSON: immportTemplate (enum) | The format of the result file depends on the assay type. ImmPort supports results templates (MBAA_Results.txt) for some of the commonly used immunological assay methods. These template facilitate the sharing and re-use of results data in a standard format. If the result file is the ImmPort results template (strongly recommended by NIAID DAIT), choose 'Yes' from the drop down list and do not include a file name in the "Result File Name" column. If the result file is not an ImmPort results template, choose 'No' from the drop down list and include a file name in the "Result File Name" column. |
| Result File Name | Optional | JSON: resultFileName (string) | Enter the full result file name including file extension. The file size name limit is 240 characters. |
| Additional Result File Names | Optional | JSON: additionalResultFileNames (array) | See the ImmPort Data Upload Guide for details on where MBAA bead level files are stored depending on the assay platform used. Separate file names by a semi-colon (;). The file size name limit is 240 characters. HIPC recommends including bead level result files if they are available. The file size name limit is 240 characters. |
| Experiment ID | Required | Text, max 100 characters JSON: experimentId (string) | The experiment identifier must be stored in ImmPort or in the experiments.txt template. Please enter either a experiment user defined ID or ImmPort accession. |
| Study ID | Conditionally required when you are defining a new Experiment in this row (rather than referencing an existing one) | Text, max 15 characters Reference — must already exist (in this package or the workspace) as a studyJSON: studyId (string) | An experiment may be linked to a single study. Please enter either a study user defined ID or ImmPort accession. |
| Protocol ID(s) | Conditionally required when you are defining a new Experiment in this row (rather than referencing an existing one) | Text, max 15 characters Reference — must already exist (in this package or the workspace) as a protocolJSON: protocolIds (array) | Please enter either a protocol user defined ID or ImmPort accession for a protocol that describes how the sample was derived and prepared. One or more identifiers can be entered per sample. Separate identifiers by semicolon (;). Please enter either a protocol user defined ID or ImmPort accession. |
| Name | Conditionally required when you are defining a new Experiment in this row (rather than referencing an existing one) | Text, max 500 characters JSON: name (string) | The experiment name is not referenced by other data records. The experiment name is an alternate identifier that is visible when the sample is shared. |
| Description | Optional | Text, max 4000 characters JSON: description (string) | The experiment description is used to describe details of the experiment not captured in other columns. |
| Measurement Technique | Conditionally required when you are defining a new Experiment in this row (rather than referencing an existing one) | Text, max 50 characters Controlled vocabulary — value must be one of lk_exp_measurement_tech JSON: measurementTechnique (enum) | The measurement technique describes the assay method. Choose from a drop down list. |