flow_cytometry_reagents
| Name | reagents.Flow_Cytometry.txt |
| JSON File Name | reagents.Flow_Cytometry.json |
| Type | multiple |
| Schema Version | 3.37 |
| Description | The flow cytometry reagent template defines and annotates the antibody reagents used for flow cytometry. |
| Download | ⬇️ reagents.Flow_Cytometry.xlsx ⬇️ reagents.Flow_Cytometry.txt ⬇️ reagents.Flow_Cytometry.json This top-level schema references companion files (e.g. reagents.Flow_Cytometry.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 |
|---|---|---|---|
| User Defined ID | Required | Text, max 100 characters JSON: userDefinedId (string) | The reagent user defined ID is an identifier chosen by the data provider to refer to an assay reagent. The nature of the assay reagent is assay specific and may be an array, an antibody or a typing kit. This ID may be referenced by other data records (e.g. experiment sample). The user defined ID is not shared. The identifier should be unique to the ImmPort workspace to which the data will be uploaded. |
| Name | Optional | Text, max 200 characters JSON: name (string) | The reagent name is not referenced by other data records. The reagent name is an alternate ID that is shared. |
| Description | Optional | Text, max 4000 characters JSON: description (string) | The assay reagent description provides further details on the nature and purpose of the reagent. A supplemental description of the assay reagent that expands on its Name and User Defined ID. |
| Manufacturer | Required | Text, max 100 characters JSON: manufacturer (string) | The source of a reagent may be important for evaluating assay results. The manufacturer is the source of a reagent and may include commercial vendors as well as non-commercial sources (e.g. collaborating labs). |
| Catalog Number | Required | Text, max 250 characters JSON: catalogNumber (string) | The reagent's catalog ID provides a reference to the reagent source and description. If the assay reagent is a commercial product, enter the vendor's catalog identifier. If the reagent is a custom preparation enter 'NA'. |
| Lot Number | Optional | Text, max 250 characters JSON: lotNumber (string) | The lot number is helpful to understand possible batch specific differences in assay results. The lot number is often provided by a reagent source when the reagent is replenished over time. |
| Weblink | Optional | Text, max 250 characters JSON: weblink (string) | The web link is often the vendor's web site. An internet address that may provide details of an assay reagent. |
| Contact | Optional | Text, max 1000 characters JSON: contact (string) | If the reagent is from a non-commercial source, the contact information should indicate with whom to communicate to get further details. The contact information is particularly helpful when the reagent is not from a commercial vendor. |
| Analyte Reported | Required | Text, max 200 characters Preferred vocabulary — reported value is kept; a preferred term from lk_analyte is filled in when it matches JSON: analyteReported (enum) | The analyte describes what is being measured in an assay. The list of values displays common immunology gene symbol and gene symbol terms on the left and their preferred term on the right, each component separated by a semi-colon. 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. The analyte is the target (e.g protein, DNA, RNA) that is being assayed by the reagent. 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. |
| Antibody Registry ID | Optional | Text, max 250 characters JSON: antibodyRegistryId (string) | The identifier assigned by the Antibody Registry to the antibody reagent. http://antibodyregistry.org/ |
| Clone Name | Required | Text, max 200 characters JSON: cloneName (string) | Flow cytometry reagents often consist of a monoclonal antibody linked to a fluorescing compound and the antibody binds to the target analyte. The detector in flow cytometry reagents is often a monoclonal antibody conjugated to a fluorochrome. When there is no antibody in the reagent, enter 'NA'. |
| Reporter Name | Required | Text, max 200 characters JSON: reporterName (string) | Flow Cytometry reagents often consist of a monoclonal antibody linked to a fluorescing compound and the fluorochrome provides the signal for the cytometer's detectors. The reporter in a flow cytometry reagent is the fluorochrome linked to an antibody. When there is no antibody in the reagent, it is the fluorescing agent (e.g. CFSE). |