cytof_derived_data
| Name | CyTOF_Derived_data.txt |
| JSON File Name | CyTOF_Derived_data.json |
| Type | multiple |
| Schema Version | 3.37 |
| Description | The CYTOF derived data template captures and annotates the assay results for a sample by linking sample, experiment, and interpreted results together. |
| Download | ⬇️ CyTOF_Derived_data.xlsx ⬇️ CyTOF_Derived_data.txt ⬇️ CyTOF_Derived_data.json This top-level schema references companion files (e.g. CyTOF_Derived_data.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 |
|---|---|---|---|
| Expsample ID | Required | Text, max 15 characters Reference — must already exist (in this package or the workspace) as a expsampleJSON: expsampleId (string) | The experiment sample identifier must be stored in ImmPort or in the experimentsamples.txt template. Please enter either an experiment sample user defined ID or ImmPort accession. |
| Population Name Reported | Required | Text, max 150 characters Preferred vocabulary — reported value is kept; a preferred term from lk_cell_population is filled in when it matches JSON: populationNameReported (enum) | The drop down list provides a list of cell population names. Please select a name if it matches your cell population name or enter a population name if there is not an appropriate one provided. The population name has a limit of 150 characters. This column can also have the format: "lineage_prefix ; population name", "population_name&modifiers", or "lineage_prefix ; population_name&modifiers". Also, if the Population Name Reported does not occur in the drop down, it will be tested against the lk_cell_population_pref_map to determine a preferred name. The population name is the type of cells whose count is reported. Please select a population name from the drop down list if it matches your cell population name or enter a name if there is not an appropriate one provided. This column can also have the format: "lineage_prefix ; population name", "population_name&modifiers", or "lineage_prefix ; population_name&modifiers". Also, if the Population Name Reported does not occur in the drop down, it will be tested against the lk_cell_population_pref_map to determine a preferred name. |
| Gating Definition Reported | Required | Text, max 150 characters Preferred vocabulary — reported value is kept; a preferred term from lk_cell_population_definition is filled in when it matches JSON: gatingDefinitionReported (enum) | he gating definition is the set of markers and their expression profile that describes a cell population name. Please select a gating definition from the drop down list if it matches your gating definition or enter a gating definition if there is not an appropriate one provided. The marker names should conform to standard names as described in the LK_ANALYTE table. Note that a comma, forward slash or pipe may be used as marker delimiter. The expression values are '-', '+', '+-', '+~', '++', or ''. The gating definition has a limit of 150 characters. The gating definition is the set of markers and their expression profile. Please select a gating definition from the drop down list or enter a gating definition. Please see the ImmPort Upload Templates for details on representing marker names, delimiters and expression values. |
| Parent Population Reported | Optional | Text, max 150 characters Preferred vocabulary — reported value is kept; a preferred term from lk_cell_population is filled in when it matches JSON: parentPopulationReported (enum) | The drop down provides the base parent population. Please select a name if it matches your base parent population name or enter a name if there is not an appropriate one provided. This column can also have the format: "lineage_prefix ; population name", "population_name&modifiers", or "lineage_prefix ; population_name&modifiers". Also, if the Parent Population Reported does not occur in the drop down, it will be tested against the lk_cell_population_pref_map to determine a preferred name. The base parent population name. Please select a population name from the drop down list if it matches your base parent population name or enter a name if there is not an appropriate one provided. This column can also have the format: "lineage_prefix ; population name", "population_name&modifiers", or "lineage_prefix ; population_name&modifiers" . Also, if the Parent Population eported does not occur in the drop down, it will be tested against the lk_cell_population_pref_map to determine a preferred name. |
| Population Statistic (count, percentile, etc) | Required | Text, max 50 characters JSON: populationStatisticCountPercentileEtc (number) | The count of the cell type defined by the marker gating definition. A number is expected. |
| Population Stat Unit Reported | Required | Text, max 100 characters Preferred vocabulary — reported value is kept; a preferred term from lk_cell_pop_statistic_unit is filled in when it matches JSON: populationStatUnitReported (enum) | The unit used to describe the cell count. Please select a unit from the drop down list if the definition matches your unit name or enter a unit if there is not an appropriate one provided. The unit used to describe the cell count. Please select a unit from the list provided if the definition matches your unit name or enter a unit if there is not an appropriate one provided. |
| Workspace File | Required | JSON: workspaceFile (string) | An XML formatted export of the analysis program is expected (e.g. an xml format of a FlowJo .jo or .wsp file). The file size name limit is 240 characters. The name of the file that stores the interpreted CyTOF results from the analysis program. The file size name limit is 240 characters. |
| Comments | Optional | Text, max 500 characters JSON: comments (string) | Comments captures additional descriptive information. |