diff --git a/docs/custom.css b/docs/custom.css index 7451d5d8..b6fe531c 100644 --- a/docs/custom.css +++ b/docs/custom.css @@ -1,3 +1,12 @@ +@font-face { + font-family: DM Sans,sans-serif; + src: url(https://fonts.googleapis.com/css2?family=DM+Sans:ital,opsz,wght@0,9..40,100..1000;1,9..40,100..100); +} + +body { + font-family: DM Sans,sans-serif; +} + div.main-container { max-width: 1200px !important; } @@ -30,7 +39,7 @@ div.info { background-repeat: no-repeat; background-image: url("info_icon.svg"); background-position: 15px center; - background-color: aliceblue; + background-color: rgba(18,94,129,.05); } @@ -74,8 +83,8 @@ div.info { .nav-pills > li > a { background-color: #fff; - border: 0 solid #e2e8f0; - border-radius: 1rem; + border: 1px solid #e2e8f0; + border-radius: 0.5rem; box-sizing: border-box; color: #0d172a; cursor: pointer; @@ -88,8 +97,7 @@ div.info { text-align: center; text-decoration: none #0d172a solid; text-decoration-thickness: auto; - transition: all .1s cubic-bezier(.4, 0, .2, 1); - box-shadow: 0px 1px 2px rgba(166, 175, 195, 0.25); + transition: all .1s cubic-bezier(.1, 0, .2, 1); user-select: none; -webkit-user-select: none; touch-action: manipulation; @@ -97,7 +105,7 @@ div.info { .nav-pills > li.active > a:hover, .nav-pills > li.active > a { - background-color: #1e293b !important; + background-color:rgb(64, 75, 99) !important; color: #fff; } @@ -106,6 +114,6 @@ div.info { .list-group-item.active, .list-group-item.active:hover, .list-group-item.active:focus { z-index: 2; color: #ffffff; - background-color: #1e293b; - border-color: #1e293b; + background-color: rgb(64, 75, 99); + border-color: rgb(64, 75, 99); } diff --git a/docs/index.Rmd b/docs/index.Rmd index b88e8055..dc02a361 100644 --- a/docs/index.Rmd +++ b/docs/index.Rmd @@ -414,7 +414,7 @@ module_section("Data", "Data", "Data") ```{r datasubtype, echo=FALSE, results='asis'} -module_section("Data", "Data", "DataSubtype") +module_section("Data", "Data", "DataSubtypeEnum") ``` diff --git a/docs/index.html b/docs/index.html index 4e9f1301..3f037602 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3107,7 +3107,14 @@ - @@ -3365,7 +3371,7 @@

NF Vocabulary / Schema

NF-OSI DCC

-

Last updated on 2023-10-26

+

Last updated on 2024-03-08

@@ -3394,48 +3400,48 @@

Genomics Assay Data
Genomics Assay (Generic)
-
- +
+
Epigenetics Assay
-
- +
+
WES Assay
-
- +
+
WGS Assay
-
- +
+
Bulk RNA-Seq Assay
-
- +
+
Single-cell RNA-Seq Assay
-
- +
+
Processed Aligned Reads
-
- +
+
Processed Variant Calls
-
- +
+
Processed Expression
-
- +
+
@@ -3443,34 +3449,34 @@

Proteomics Assay Templates

Proteomics Assay (Generic)
-
- +
+

Imaging Assay Templates

Imaging Assay (Generic)
-
- +
+
MRI Assay
-
- +
+

Other Assay Templates

Pharmacokinetics Assay
-
- +
+
Plate Based Reporter Assay
-
- +
+
@@ -3478,29 +3484,29 @@

Clinical Assay Templates

Clinical Assay (Generic)
-
- +
+

Other Assays

Light Scattering
-
- +
+

Non-Assay Templates

Protocol
-
- +
+
Source Code
-
- +
+
@@ -3517,18 +3523,18 @@

Annotation Vocabulary

Assay

AssayEnum

-
+
- +


PlatformEnum

-
+
- +


Relations Graph
@@ -3547,34 +3553,34 @@
Relations Graph

Information Entity

Resource

-
+
- +


Data

-
+
- +


-
-

DataSubtype

-
+
+

DataSubtypeEnum

+
- +


FileFormatEnum

-
+
- +


@@ -3587,79 +3593,87 @@

Sample

individual-level and specimen-level data. Data can be linked to individual-level sample information such as sex, species, diagnosis, and genotype. Data can be linked to specimen-level information such as -sample site (the organ or body part), specimen tissue or cell type, -tumor class (if specimen is a tumor), and specimen state.

+sample site (the organ or body part), specimen type or cell type, tumor +class (if specimen is a tumor), and specimen state.

+
+
+

Tissue

+
+ +
+ +


-
-

TissueEnum

-
+
+

OrganismSubstance

+
- +


Tumor

-
+
- +


SexEnum

-
+
- +


DiagnosisEnum

-
+
- +


Genotype

-
+
- +


SpeciesEnum

-
+
- +


Cell

-
+
- +


CellLineModel

-
+
- +


MouseModel

-
+
- +


@@ -3670,10 +3684,10 @@

Experiment

TimeUnit

-
+
- +


diff --git a/docs/templates/Clinical_Assay_Template.csv b/docs/templates/Clinical_Assay_Template.csv index 6dcd5de0..3735df55 100644 --- a/docs/templates/Clinical_Assay_Template.csv +++ b/docs/templates/Clinical_Assay_Template.csv @@ -1,13 +1,14 @@ "Field","Description","Required","ValidRange" "Component","Type of metadata template; provide the same one for all items/rows.","true","#" "assay","The technology used to generate the data in this file.","true","#AssayEnum" -"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtype" -"dataType","A type of data -- experimental, clinical, or other. Most typically refers to a high-level data type that can be related to an assay type. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. +"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtypeEnum" +"dataType","Links an entity to data types that the entity represents/contains. This is closely tied to the assay property. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. ","true","#Data|#Metadata" "fileFormat","Defined format of the data file, typically corresponding to extension, but sometimes indicating more general group of files produced by the same tool or software","true","#FileFormatEnum" "individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","true","#" "resourceType","The type of resource being stored and annotated","true","#Resource" "species","The name of a species (typically a taxonomic group) of organism.","true","#SpeciesEnum" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","true","#Tumor" "Filename","The name of the file.","false","#" "age","A numeric value representing age of the individual. Use with `ageUnit`.","false","#" "ageUnit","A time unit that can be used with a given age value, e.g. years.","false","#TimeUnit" @@ -15,11 +16,12 @@ "compoundDose","A dose quantity for the treatment compound. To be used with compoundDoseUnit.","false","#" "compoundDoseUnit","A unit associated with the value(s) in compoundDose.","false","#" "compoundName","Common name for a compound, e.g. “Selumetinib” (https://pubchem.ncbi.nlm.nih.gov/compound/10127622)","false","#" -"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","false","#DiagnosisEnum" +"diagnosis","Diagnosis for the individual given signs and symptoms. Use the most specific diagnosis term that applies.","false","#DiagnosisEnum" "experimentalCondition","A free-text description of the experimental condition (e.g. 5 mM doxorubicin).","false","#" "experimentalFactor","An ontology concept for experimental factor measured with this data.","false","#Measurement" "modelSystemName","A group of presumed common ancestry with clear-cut physiological but usually not morphological distinctions such as an animal model or cell line. EXAMPLE(S): HEK293 (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","false","#CellLineModel|#MouseModel" "nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known.","false","#Genotype|#UnknownEnum" "nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","false","#Genotype|#UnknownEnum" +"organ","A unique macroscopic (gross) anatomic structure that performs specific functions. It is composed of various tissues. An organ is part of an anatomic system or a body region.","false","#OrganEnum" "sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","false","#SexEnum|#UnknownEnum|#NotApplicableEnum" "timepointUnit","For timed experiments this represents the unit of time measured","false","#TimeUnit" diff --git a/docs/templates/Epigenetics_Assay_Template.csv b/docs/templates/Epigenetics_Assay_Template.csv index 706ccdf9..13dfd598 100644 --- a/docs/templates/Epigenetics_Assay_Template.csv +++ b/docs/templates/Epigenetics_Assay_Template.csv @@ -1,8 +1,8 @@ "Field","Description","Required","ValidRange" "Component","Type of metadata template; provide the same one for all items/rows.","true","#" "assay","The technology used to generate the data in this file.","true","#AssayEnum" -"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtype" -"dataType","A type of data -- experimental, clinical, or other. Most typically refers to a high-level data type that can be related to an assay type. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. +"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtypeEnum" +"dataType","Links an entity to data types that the entity represents/contains. This is closely tied to the assay property. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. ","true","#Data|#Metadata" "fileFormat","Defined format of the data file, typically corresponding to extension, but sometimes indicating more general group of files produced by the same tool or software","true","#FileFormatEnum" "individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","true","#" @@ -21,12 +21,14 @@ "aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID.","false","#" "batchID","Batch identifier, can be used in any context where added batch information is helpful, such as different sequencing runs or collection times.","false","#" "bisulfiteConversionKitID","Name of kit used in bisulfite conversion.","false","#" -"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","false","#DiagnosisEnum" +"comments","Brief free-text comments that may also be important to understanding the resource.","false","#" +"diagnosis","Diagnosis for the individual given signs and symptoms. Use the most specific diagnosis term that applies.","false","#DiagnosisEnum" "libraryPrep","The general strategy by which the library was prepared","false","#LibraryPrepEnum" "modelSystemName","A group of presumed common ancestry with clear-cut physiological but usually not morphological distinctions such as an animal model or cell line. EXAMPLE(S): HEK293 (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","false","#CellLineModel|#MouseModel" "nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known.","false","#Genotype|#UnknownEnum" "nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","false","#Genotype|#UnknownEnum" "nucleicAcidSource","Source of the extracted nucleic acid used in the experiment","false","#NucleicAcidSourceEnum" +"organ","A unique macroscopic (gross) anatomic structure that performs specific functions. It is composed of various tissues. An organ is part of an anatomic system or a body region.","false","#OrganEnum" "parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor that was subsectioned into several samples. The parentSpecimenID can be the same as specimenID when there is no subsectioning. ","false","#" "readDepth","If available, the coverage statistic as output from bedtools coverage or samtools stats.","false","#" @@ -34,5 +36,6 @@ "readPair","The read of origin, Read 1 or Read 2","false","#" "runType","Sequencing run type.","false","#RunTypeEnum" "sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","false","#SexEnum|#UnknownEnum|#NotApplicableEnum" +"specimenType","The type of a material sample taken from a biological entity for testing, diagnostic, propagation, treatment or research purposes. This includes particular types of cellular molecules, cells, tissues, organs, body fluids, embryos, and body excretory substances. +","false","#Tissue|#OrganismSubstance" "targetDepth","The targeted read depth prior to sequencing.","false","#" -"tissue","A tissue is a mereologically maximal collection of cells that together perform physiological function.","false","#TissueEnum" diff --git a/docs/templates/Genomics_Assay_Template.csv b/docs/templates/Genomics_Assay_Template.csv index c73edbd6..ba985fbb 100644 --- a/docs/templates/Genomics_Assay_Template.csv +++ b/docs/templates/Genomics_Assay_Template.csv @@ -1,8 +1,8 @@ "Field","Description","Required","ValidRange" "Component","Type of metadata template; provide the same one for all items/rows.","true","#" "assay","The technology used to generate the data in this file.","true","#AssayEnum" -"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtype" -"dataType","A type of data -- experimental, clinical, or other. Most typically refers to a high-level data type that can be related to an assay type. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. +"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtypeEnum" +"dataType","Links an entity to data types that the entity represents/contains. This is closely tied to the assay property. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. ","true","#Data|#Metadata" "fileFormat","Defined format of the data file, typically corresponding to extension, but sometimes indicating more general group of files produced by the same tool or software","true","#FileFormatEnum" "individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","true","#" @@ -20,12 +20,14 @@ "ageUnit","A time unit that can be used with a given age value, e.g. years.","false","#TimeUnit" "aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID.","false","#" "batchID","Batch identifier, can be used in any context where added batch information is helpful, such as different sequencing runs or collection times.","false","#" -"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","false","#DiagnosisEnum" +"comments","Brief free-text comments that may also be important to understanding the resource.","false","#" +"diagnosis","Diagnosis for the individual given signs and symptoms. Use the most specific diagnosis term that applies.","false","#DiagnosisEnum" "libraryPrep","The general strategy by which the library was prepared","false","#LibraryPrepEnum" "modelSystemName","A group of presumed common ancestry with clear-cut physiological but usually not morphological distinctions such as an animal model or cell line. EXAMPLE(S): HEK293 (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","false","#CellLineModel|#MouseModel" "nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known.","false","#Genotype|#UnknownEnum" "nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","false","#Genotype|#UnknownEnum" "nucleicAcidSource","Source of the extracted nucleic acid used in the experiment","false","#NucleicAcidSourceEnum" +"organ","A unique macroscopic (gross) anatomic structure that performs specific functions. It is composed of various tissues. An organ is part of an anatomic system or a body region.","false","#OrganEnum" "parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor that was subsectioned into several samples. The parentSpecimenID can be the same as specimenID when there is no subsectioning. ","false","#" "readDepth","If available, the coverage statistic as output from bedtools coverage or samtools stats.","false","#" @@ -33,5 +35,6 @@ "readPair","The read of origin, Read 1 or Read 2","false","#" "runType","Sequencing run type.","false","#RunTypeEnum" "sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","false","#SexEnum|#UnknownEnum|#NotApplicableEnum" +"specimenType","The type of a material sample taken from a biological entity for testing, diagnostic, propagation, treatment or research purposes. This includes particular types of cellular molecules, cells, tissues, organs, body fluids, embryos, and body excretory substances. +","false","#Tissue|#OrganismSubstance" "targetDepth","The targeted read depth prior to sequencing.","false","#" -"tissue","A tissue is a mereologically maximal collection of cells that together perform physiological function.","false","#TissueEnum" diff --git a/docs/templates/Imaging_Assay_Template.csv b/docs/templates/Imaging_Assay_Template.csv index 90fd8dcb..f4c206b4 100644 --- a/docs/templates/Imaging_Assay_Template.csv +++ b/docs/templates/Imaging_Assay_Template.csv @@ -1,21 +1,25 @@ "Field","Description","Required","ValidRange" "Component","Type of metadata template; provide the same one for all items/rows.","true","#" "assay","The technology used to generate the data in this file.","true","#AssayEnum" -"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtype" -"dataType","A type of data -- experimental, clinical, or other. Most typically refers to a high-level data type that can be related to an assay type. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. +"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtypeEnum" +"dataType","Links an entity to data types that the entity represents/contains. This is closely tied to the assay property. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. ","true","#Data|#Metadata" "fileFormat","Defined format of the data file, typically corresponding to extension, but sometimes indicating more general group of files produced by the same tool or software","true","#FileFormatEnum" "individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","true","#" "platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data.","true","#PlatformEnum" "resourceType","The type of resource being stored and annotated","true","#Resource" "species","The name of a species (typically a taxonomic group) of organism.","true","#SpeciesEnum" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","true","#Tumor" "Filename","The name of the file.","false","#" "age","A numeric value representing age of the individual. Use with `ageUnit`.","false","#" "ageUnit","A time unit that can be used with a given age value, e.g. years.","false","#TimeUnit" +"assayTarget","Target of the assay such as a HUGO gene symbol, cell type, or tissue region depending on the capabilities of the assay.","false","#" "auxiliaryAsset","URI to supplemental asset(s), e.g. QC reports or other auxiliary files to support the processing, analysis, or interpretation of the current entity. ","false","#" -"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","false","#DiagnosisEnum" +"comments","Brief free-text comments that may also be important to understanding the resource.","false","#" +"diagnosis","Diagnosis for the individual given signs and symptoms. Use the most specific diagnosis term that applies.","false","#DiagnosisEnum" "modelSystemName","A group of presumed common ancestry with clear-cut physiological but usually not morphological distinctions such as an animal model or cell line. EXAMPLE(S): HEK293 (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","false","#CellLineModel|#MouseModel" "nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known.","false","#Genotype|#UnknownEnum" "nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","false","#Genotype|#UnknownEnum" +"organ","A unique macroscopic (gross) anatomic structure that performs specific functions. It is composed of various tissues. An organ is part of an anatomic system or a body region.","false","#OrganEnum" "sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","false","#SexEnum|#UnknownEnum|#NotApplicableEnum" diff --git a/docs/templates/Light_Scattering_Assay_Template.csv b/docs/templates/Light_Scattering_Assay_Template.csv index 059f5a26..825636f9 100644 --- a/docs/templates/Light_Scattering_Assay_Template.csv +++ b/docs/templates/Light_Scattering_Assay_Template.csv @@ -1,8 +1,8 @@ "Field","Description","Required","ValidRange" "Component","Type of metadata template; provide the same one for all items/rows.","true","#" "assay","The technology used to generate the data in this file.","true","#AssayEnum" -"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtype" -"dataType","A type of data -- experimental, clinical, or other. Most typically refers to a high-level data type that can be related to an assay type. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. +"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtypeEnum" +"dataType","Links an entity to data types that the entity represents/contains. This is closely tied to the assay property. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. ","true","#Data|#Metadata" "platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data.","true","#PlatformEnum" "resourceType","The type of resource being stored and annotated","true","#Resource" diff --git a/docs/templates/MRI_Assay_Template.csv b/docs/templates/MRI_Assay_Template.csv index 86965dba..c325e870 100644 --- a/docs/templates/MRI_Assay_Template.csv +++ b/docs/templates/MRI_Assay_Template.csv @@ -1,26 +1,30 @@ "Field","Description","Required","ValidRange" "Component","Type of metadata template; provide the same one for all items/rows.","true","#" "assay","The technology used to generate the data in this file.","true","#AssayEnum" -"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtype" -"dataType","A type of data -- experimental, clinical, or other. Most typically refers to a high-level data type that can be related to an assay type. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. +"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtypeEnum" +"dataType","Links an entity to data types that the entity represents/contains. This is closely tied to the assay property. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. ","true","#Data|#Metadata" "fileFormat","Defined format of the data file, typically corresponding to extension, but sometimes indicating more general group of files produced by the same tool or software","true","#FileFormatEnum" "individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","true","#" "platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data.","true","#PlatformEnum" "resourceType","The type of resource being stored and annotated","true","#Resource" "species","The name of a species (typically a taxonomic group) of organism.","true","#SpeciesEnum" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","true","#Tumor" "Filename","The name of the file.","false","#" "MRISequence","A mode used in MRI imaging","false","#MRISequenceEnum" "age","A numeric value representing age of the individual. Use with `ageUnit`.","false","#" "ageUnit","A time unit that can be used with a given age value, e.g. years.","false","#TimeUnit" +"assayTarget","Target of the assay such as a HUGO gene symbol, cell type, or tissue region depending on the capabilities of the assay.","false","#" "auxiliaryAsset","URI to supplemental asset(s), e.g. QC reports or other auxiliary files to support the processing, analysis, or interpretation of the current entity. ","false","#" "bodySite","Sample location referring to a named area of the body, inclusive of gross anatomical structures and organ parts.","false","#BodyPartEnum" -"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","false","#DiagnosisEnum" +"comments","Brief free-text comments that may also be important to understanding the resource.","false","#" +"diagnosis","Diagnosis for the individual given signs and symptoms. Use the most specific diagnosis term that applies.","false","#DiagnosisEnum" "experimentalCondition","A free-text description of the experimental condition (e.g. 5 mM doxorubicin).","false","#" "experimentalTimepoint","The numeric value indicating the time elapsed from the beginning of the experiment at which the specimen was collected. Use in tandem with timePointUnit","false","#" "modelSystemName","A group of presumed common ancestry with clear-cut physiological but usually not morphological distinctions such as an animal model or cell line. EXAMPLE(S): HEK293 (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","false","#CellLineModel|#MouseModel" "nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known.","false","#Genotype|#UnknownEnum" "nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","false","#Genotype|#UnknownEnum" +"organ","A unique macroscopic (gross) anatomic structure that performs specific functions. It is composed of various tissues. An organ is part of an anatomic system or a body region.","false","#OrganEnum" "sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","false","#SexEnum|#UnknownEnum|#NotApplicableEnum" "timepointUnit","For timed experiments this represents the unit of time measured","false","#TimeUnit" diff --git a/docs/templates/Pharmacokinetics_Assay_Template.csv b/docs/templates/Pharmacokinetics_Assay_Template.csv index 25c1c9f4..6381dfef 100644 --- a/docs/templates/Pharmacokinetics_Assay_Template.csv +++ b/docs/templates/Pharmacokinetics_Assay_Template.csv @@ -1,8 +1,8 @@ "Field","Description","Required","ValidRange" "Component","Type of metadata template; provide the same one for all items/rows.","true","#" "assay","The technology used to generate the data in this file.","true","#AssayEnum" -"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtype" -"dataType","A type of data -- experimental, clinical, or other. Most typically refers to a high-level data type that can be related to an assay type. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. +"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtypeEnum" +"dataType","Links an entity to data types that the entity represents/contains. This is closely tied to the assay property. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. ","true","#Data|#Metadata" "fileFormat","Defined format of the data file, typically corresponding to extension, but sometimes indicating more general group of files produced by the same tool or software","true","#FileFormatEnum" "individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","true","#" @@ -11,19 +11,22 @@ "species","The name of a species (typically a taxonomic group) of organism.","true","#SpeciesEnum" "specimenID","A unique identifier (non-PII) that represents the subspecimen (subsample) from which the data came, e.g. an ID that distinguishes between different parts of the same parent tumor specimen. ","true","#" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","true","#Tumor" "Filename","The name of the file.","false","#" "age","A numeric value representing age of the individual. Use with `ageUnit`.","false","#" "ageUnit","A time unit that can be used with a given age value, e.g. years.","false","#TimeUnit" "aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID.","false","#" +"comments","Brief free-text comments that may also be important to understanding the resource.","false","#" "compoundDose","A dose quantity for the treatment compound. To be used with compoundDoseUnit.","false","#" "compoundDoseUnit","A unit associated with the value(s) in compoundDose.","false","#" "compoundName","Common name for a compound, e.g. “Selumetinib” (https://pubchem.ncbi.nlm.nih.gov/compound/10127622)","false","#" -"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","false","#DiagnosisEnum" +"diagnosis","Diagnosis for the individual given signs and symptoms. Use the most specific diagnosis term that applies.","false","#DiagnosisEnum" "experimentalCondition","A free-text description of the experimental condition (e.g. 5 mM doxorubicin).","false","#" "experimentalTimepoint","The numeric value indicating the time elapsed from the beginning of the experiment at which the specimen was collected. Use in tandem with timePointUnit","false","#" "modelSystemName","A group of presumed common ancestry with clear-cut physiological but usually not morphological distinctions such as an animal model or cell line. EXAMPLE(S): HEK293 (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","false","#CellLineModel|#MouseModel" "nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known.","false","#Genotype|#UnknownEnum" "nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","false","#Genotype|#UnknownEnum" +"organ","A unique macroscopic (gross) anatomic structure that performs specific functions. It is composed of various tissues. An organ is part of an anatomic system or a body region.","false","#OrganEnum" "parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor that was subsectioned into several samples. The parentSpecimenID can be the same as specimenID when there is no subsectioning. ","false","#" "sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","false","#SexEnum|#UnknownEnum|#NotApplicableEnum" diff --git a/docs/templates/Plate_Based_Reporter_Assay_Template.csv b/docs/templates/Plate_Based_Reporter_Assay_Template.csv index 8a14206f..c566b2b7 100644 --- a/docs/templates/Plate_Based_Reporter_Assay_Template.csv +++ b/docs/templates/Plate_Based_Reporter_Assay_Template.csv @@ -1,8 +1,8 @@ "Field","Description","Required","ValidRange" "Component","Type of metadata template; provide the same one for all items/rows.","true","#" "assay","The technology used to generate the data in this file.","true","#AssayEnum" -"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtype" -"dataType","A type of data -- experimental, clinical, or other. Most typically refers to a high-level data type that can be related to an assay type. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. +"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtypeEnum" +"dataType","Links an entity to data types that the entity represents/contains. This is closely tied to the assay property. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. ","true","#Data|#Metadata" "fileFormat","Defined format of the data file, typically corresponding to extension, but sometimes indicating more general group of files produced by the same tool or software","true","#FileFormatEnum" "individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","true","#" @@ -11,20 +11,23 @@ "species","The name of a species (typically a taxonomic group) of organism.","true","#SpeciesEnum" "specimenID","A unique identifier (non-PII) that represents the subspecimen (subsample) from which the data came, e.g. an ID that distinguishes between different parts of the same parent tumor specimen. ","true","#" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","true","#Tumor" "Filename","The name of the file.","false","#" "age","A numeric value representing age of the individual. Use with `ageUnit`.","false","#" "ageUnit","A time unit that can be used with a given age value, e.g. years.","false","#TimeUnit" "aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID.","false","#" -"assayTarget","The HUGO gene symbol that represents the target assayed.","false","#" +"assayTarget","Target of the assay such as a HUGO gene symbol, cell type, or tissue region depending on the capabilities of the assay.","false","#" +"comments","Brief free-text comments that may also be important to understanding the resource.","false","#" "compoundDose","A dose quantity for the treatment compound. To be used with compoundDoseUnit.","false","#" "compoundDoseUnit","A unit associated with the value(s) in compoundDose.","false","#" "compoundName","Common name for a compound, e.g. “Selumetinib” (https://pubchem.ncbi.nlm.nih.gov/compound/10127622)","false","#" -"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","false","#DiagnosisEnum" +"diagnosis","Diagnosis for the individual given signs and symptoms. Use the most specific diagnosis term that applies.","false","#DiagnosisEnum" "experimentalCondition","A free-text description of the experimental condition (e.g. 5 mM doxorubicin).","false","#" "experimentalTimepoint","The numeric value indicating the time elapsed from the beginning of the experiment at which the specimen was collected. Use in tandem with timePointUnit","false","#" "modelSystemName","A group of presumed common ancestry with clear-cut physiological but usually not morphological distinctions such as an animal model or cell line. EXAMPLE(S): HEK293 (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","false","#CellLineModel|#MouseModel" "nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known.","false","#Genotype|#UnknownEnum" "nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","false","#Genotype|#UnknownEnum" +"organ","A unique macroscopic (gross) anatomic structure that performs specific functions. It is composed of various tissues. An organ is part of an anatomic system or a body region.","false","#OrganEnum" "parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor that was subsectioned into several samples. The parentSpecimenID can be the same as specimenID when there is no subsectioning. ","false","#" "reporterGene","A gene which produces an easily assayed phenotype. Often used for expression studies of heterologous promoters.","false","#" diff --git a/docs/templates/Processed_Aligned_Reads_Template.csv b/docs/templates/Processed_Aligned_Reads_Template.csv index 42117f6e..396898d6 100644 --- a/docs/templates/Processed_Aligned_Reads_Template.csv +++ b/docs/templates/Processed_Aligned_Reads_Template.csv @@ -1,14 +1,15 @@ "Field","Description","Required","ValidRange" "Component","Type of metadata template; provide the same one for all items/rows.","true","#" "assay","The technology used to generate the data in this file.","true","#AssayEnum" -"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtype" -"dataType","A type of data -- experimental, clinical, or other. Most typically refers to a high-level data type that can be related to an assay type. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. +"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtypeEnum" +"dataType","Links an entity to data types that the entity represents/contains. This is closely tied to the assay property. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. ","true","#Data|#Metadata" "fileFormat","Defined format of the data file, typically corresponding to extension, but sometimes indicating more general group of files produced by the same tool or software","true","#FileFormatEnum" "genomicReference","Version of genome reference used for alignment in processing workflow","true","#" "individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","true","#" "resourceType","The type of resource being stored and annotated","true","#Resource" "species","The name of a species (typically a taxonomic group) of organism.","true","#SpeciesEnum" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","true","#Tumor" "Filename","The name of the file.","false","#" "age","A numeric value representing age of the individual. Use with `ageUnit`.","false","#" "ageUnit","A time unit that can be used with a given age value, e.g. years.","false","#TimeUnit" @@ -17,12 +18,14 @@ "averageBaseQuality","Average base quality collected from samtools","false","#" "averageInsertSize","Average insert size as reported by samtools","false","#" "averageReadLength","Average read length collected from samtools","false","#" -"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","false","#DiagnosisEnum" +"comments","Brief free-text comments that may also be important to understanding the resource.","false","#" +"diagnosis","Diagnosis for the individual given signs and symptoms. Use the most specific diagnosis term that applies.","false","#DiagnosisEnum" "genomicReferenceLink","Link to genome reference data file used for alignment in processing workflow","false","#" "meanCoverage","Mean coverage for whole genome sequencing, or mean target coverage for whole exome and targeted sequencing, collected from Picard Tools","false","#" "modelSystemName","A group of presumed common ancestry with clear-cut physiological but usually not morphological distinctions such as an animal model or cell line. EXAMPLE(S): HEK293 (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","false","#CellLineModel|#MouseModel" "nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known.","false","#Genotype|#UnknownEnum" "nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","false","#Genotype|#UnknownEnum" +"organ","A unique macroscopic (gross) anatomic structure that performs specific functions. It is composed of various tissues. An organ is part of an anatomic system or a body region.","false","#OrganEnum" "pairsOnDifferentChr","Pairs on different chromosomes collected from samtools","false","#" "proportionCoverage10x","Proportion of all reference bases for whole genome sequencing, or targeted bases for whole exome and targeted sequencing, that achieves 10X or greater coverage from Picard Tools","false","#" "proportionCoverage30x","Proportion of all reference bases for whole genome sequencing, or targeted bases for whole exome and targeted sequencing, that achieves 30X or greater coverage from Picard Tools","false","#" diff --git a/docs/templates/Processed_Expression_Template.csv b/docs/templates/Processed_Expression_Template.csv index 21303877..80aec501 100644 --- a/docs/templates/Processed_Expression_Template.csv +++ b/docs/templates/Processed_Expression_Template.csv @@ -1,21 +1,26 @@ "Field","Description","Required","ValidRange" "Component","Type of metadata template; provide the same one for all items/rows.","true","#" "assay","The technology used to generate the data in this file.","true","#AssayEnum" -"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtype" -"dataType","A type of data -- experimental, clinical, or other. Most typically refers to a high-level data type that can be related to an assay type. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. +"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtypeEnum" +"dataType","Links an entity to data types that the entity represents/contains. This is closely tied to the assay property. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. ","true","#Data|#Metadata" "fileFormat","Defined format of the data file, typically corresponding to extension, but sometimes indicating more general group of files produced by the same tool or software","true","#FileFormatEnum" "individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","true","#" "resourceType","The type of resource being stored and annotated","true","#Resource" "species","The name of a species (typically a taxonomic group) of organism.","true","#SpeciesEnum" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","true","#Tumor" "Filename","The name of the file.","false","#" "age","A numeric value representing age of the individual. Use with `ageUnit`.","false","#" "ageUnit","A time unit that can be used with a given age value, e.g. years.","false","#TimeUnit" -"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","false","#DiagnosisEnum" +"auxiliaryAsset","URI to supplemental asset(s), e.g. QC reports or other auxiliary files to support the processing, analysis, or interpretation of the current entity. +","false","#" +"comments","Brief free-text comments that may also be important to understanding the resource.","false","#" +"diagnosis","Diagnosis for the individual given signs and symptoms. Use the most specific diagnosis term that applies.","false","#DiagnosisEnum" "expressionUnit","Measure used for transcript expression quantification","false","#ExpressionUnitEnum" "modelSystemName","A group of presumed common ancestry with clear-cut physiological but usually not morphological distinctions such as an animal model or cell line. EXAMPLE(S): HEK293 (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","false","#CellLineModel|#MouseModel" "nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known.","false","#Genotype|#UnknownEnum" "nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","false","#Genotype|#UnknownEnum" +"organ","A unique macroscopic (gross) anatomic structure that performs specific functions. It is composed of various tissues. An organ is part of an anatomic system or a body region.","false","#OrganEnum" "sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","false","#SexEnum|#UnknownEnum|#NotApplicableEnum" "workflow","Name and version of the workflow used to generate/analyze the data","false","#WorkflowEnum" "workflowLink","Workflow URL reference","false","#" diff --git a/docs/templates/Processed_Variant_Calls_Template.csv b/docs/templates/Processed_Variant_Calls_Template.csv index 93346eec..f6c011b5 100644 --- a/docs/templates/Processed_Variant_Calls_Template.csv +++ b/docs/templates/Processed_Variant_Calls_Template.csv @@ -1,23 +1,26 @@ "Field","Description","Required","ValidRange" "Component","Type of metadata template; provide the same one for all items/rows.","true","#" "assay","The technology used to generate the data in this file.","true","#AssayEnum" -"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtype" -"dataType","A type of data -- experimental, clinical, or other. Most typically refers to a high-level data type that can be related to an assay type. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. +"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtypeEnum" +"dataType","Links an entity to data types that the entity represents/contains. This is closely tied to the assay property. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. ","true","#Data|#Metadata" "fileFormat","Defined format of the data file, typically corresponding to extension, but sometimes indicating more general group of files produced by the same tool or software","true","#FileFormatEnum" "individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","true","#" "resourceType","The type of resource being stored and annotated","true","#Resource" "species","The name of a species (typically a taxonomic group) of organism.","true","#SpeciesEnum" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","true","#Tumor" "Filename","The name of the file.","false","#" "age","A numeric value representing age of the individual. Use with `ageUnit`.","false","#" "ageUnit","A time unit that can be used with a given age value, e.g. years.","false","#TimeUnit" "auxiliaryAsset","URI to supplemental asset(s), e.g. QC reports or other auxiliary files to support the processing, analysis, or interpretation of the current entity. ","false","#" -"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","false","#DiagnosisEnum" +"comments","Brief free-text comments that may also be important to understanding the resource.","false","#" +"diagnosis","Diagnosis for the individual given signs and symptoms. Use the most specific diagnosis term that applies.","false","#DiagnosisEnum" "isFilteredReads","Whether the reads in the processed result has been filtered by adding a 'PASS' filter or other filters as determined by the data generator","false","#" "modelSystemName","A group of presumed common ancestry with clear-cut physiological but usually not morphological distinctions such as an animal model or cell line. EXAMPLE(S): HEK293 (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","false","#CellLineModel|#MouseModel" "nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known.","false","#Genotype|#UnknownEnum" "nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","false","#Genotype|#UnknownEnum" +"organ","A unique macroscopic (gross) anatomic structure that performs specific functions. It is composed of various tissues. An organ is part of an anatomic system or a body region.","false","#OrganEnum" "sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","false","#SexEnum|#UnknownEnum|#NotApplicableEnum" "workflow","Name and version of the workflow used to generate/analyze the data","false","#WorkflowEnum" "workflowLink","Workflow URL reference","false","#" diff --git a/docs/templates/Proteomics_Assay_Template.csv b/docs/templates/Proteomics_Assay_Template.csv index 308449ef..04b33622 100644 --- a/docs/templates/Proteomics_Assay_Template.csv +++ b/docs/templates/Proteomics_Assay_Template.csv @@ -2,8 +2,8 @@ "Component","Type of metadata template; provide the same one for all items/rows.","true","#" "assay","The technology used to generate the data in this file.","true","#AssayEnum" "dataCollectionMode","Mode of data collection in tandem MS assays. Either DDA (data-dependent acquisition) or DIA (data-independent) acquisition.","true","#" -"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtype" -"dataType","A type of data -- experimental, clinical, or other. Most typically refers to a high-level data type that can be related to an assay type. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. +"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtypeEnum" +"dataType","Links an entity to data types that the entity represents/contains. This is closely tied to the assay property. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. ","true","#Data|#Metadata" "fileFormat","Defined format of the data file, typically corresponding to extension, but sometimes indicating more general group of files produced by the same tool or software","true","#FileFormatEnum" "individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","true","#" @@ -12,14 +12,17 @@ "species","The name of a species (typically a taxonomic group) of organism.","true","#SpeciesEnum" "specimenID","A unique identifier (non-PII) that represents the subspecimen (subsample) from which the data came, e.g. an ID that distinguishes between different parts of the same parent tumor specimen. ","true","#" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","true","#Tumor" "Filename","The name of the file.","false","#" "age","A numeric value representing age of the individual. Use with `ageUnit`.","false","#" "ageUnit","A time unit that can be used with a given age value, e.g. years.","false","#TimeUnit" "aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID.","false","#" -"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","false","#DiagnosisEnum" +"comments","Brief free-text comments that may also be important to understanding the resource.","false","#" +"diagnosis","Diagnosis for the individual given signs and symptoms. Use the most specific diagnosis term that applies.","false","#DiagnosisEnum" "modelSystemName","A group of presumed common ancestry with clear-cut physiological but usually not morphological distinctions such as an animal model or cell line. EXAMPLE(S): HEK293 (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","false","#CellLineModel|#MouseModel" "nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known.","false","#Genotype|#UnknownEnum" "nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","false","#Genotype|#UnknownEnum" +"organ","A unique macroscopic (gross) anatomic structure that performs specific functions. It is composed of various tissues. An organ is part of an anatomic system or a body region.","false","#OrganEnum" "parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor that was subsectioned into several samples. The parentSpecimenID can be the same as specimenID when there is no subsectioning. ","false","#" "proteinExtractSource","Source of the extracted protein used in the experiment","false","#ProteinExtractSourceEnum" diff --git a/docs/templates/Protocol_Template.csv b/docs/templates/Protocol_Template.csv index 01d796b3..ab848ad7 100644 --- a/docs/templates/Protocol_Template.csv +++ b/docs/templates/Protocol_Template.csv @@ -1,9 +1,9 @@ "Field","Description","Required","ValidRange" -"title","Title of a resource.","true","#" +"title","Title of a resource.","true","#string" "author","The author of the resource; preferably use an ORCID ID, GitHub profile link, etc., if available and a text name if not.","false","#" "citation","Citation (e.g. doi) that usage of data or resource should be cited with.","false","#" "comments","Brief free-text comments that may also be important to understanding the resource.","false","#" -"license","Link to a license or name of license applicable for the resource.","false","#" +"license","Link to a license or name of license applicable for the resource.","false","#string" "protocolAssay","Main assay type that this protocol is related to, e.g. this is a prep protocol for single-cell RNA-seq assay. This is especially helpful for newly-developed or in-house assays. ","false","#AssayEnum" "protocolPurpose","Brief description of the protocol purpose.","false","#" diff --git a/docs/templates/RNASeq_Template.csv b/docs/templates/RNASeq_Template.csv index c73edbd6..ba985fbb 100644 --- a/docs/templates/RNASeq_Template.csv +++ b/docs/templates/RNASeq_Template.csv @@ -1,8 +1,8 @@ "Field","Description","Required","ValidRange" "Component","Type of metadata template; provide the same one for all items/rows.","true","#" "assay","The technology used to generate the data in this file.","true","#AssayEnum" -"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtype" -"dataType","A type of data -- experimental, clinical, or other. Most typically refers to a high-level data type that can be related to an assay type. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. +"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtypeEnum" +"dataType","Links an entity to data types that the entity represents/contains. This is closely tied to the assay property. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. ","true","#Data|#Metadata" "fileFormat","Defined format of the data file, typically corresponding to extension, but sometimes indicating more general group of files produced by the same tool or software","true","#FileFormatEnum" "individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","true","#" @@ -20,12 +20,14 @@ "ageUnit","A time unit that can be used with a given age value, e.g. years.","false","#TimeUnit" "aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID.","false","#" "batchID","Batch identifier, can be used in any context where added batch information is helpful, such as different sequencing runs or collection times.","false","#" -"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","false","#DiagnosisEnum" +"comments","Brief free-text comments that may also be important to understanding the resource.","false","#" +"diagnosis","Diagnosis for the individual given signs and symptoms. Use the most specific diagnosis term that applies.","false","#DiagnosisEnum" "libraryPrep","The general strategy by which the library was prepared","false","#LibraryPrepEnum" "modelSystemName","A group of presumed common ancestry with clear-cut physiological but usually not morphological distinctions such as an animal model or cell line. EXAMPLE(S): HEK293 (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","false","#CellLineModel|#MouseModel" "nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known.","false","#Genotype|#UnknownEnum" "nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","false","#Genotype|#UnknownEnum" "nucleicAcidSource","Source of the extracted nucleic acid used in the experiment","false","#NucleicAcidSourceEnum" +"organ","A unique macroscopic (gross) anatomic structure that performs specific functions. It is composed of various tissues. An organ is part of an anatomic system or a body region.","false","#OrganEnum" "parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor that was subsectioned into several samples. The parentSpecimenID can be the same as specimenID when there is no subsectioning. ","false","#" "readDepth","If available, the coverage statistic as output from bedtools coverage or samtools stats.","false","#" @@ -33,5 +35,6 @@ "readPair","The read of origin, Read 1 or Read 2","false","#" "runType","Sequencing run type.","false","#RunTypeEnum" "sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","false","#SexEnum|#UnknownEnum|#NotApplicableEnum" +"specimenType","The type of a material sample taken from a biological entity for testing, diagnostic, propagation, treatment or research purposes. This includes particular types of cellular molecules, cells, tissues, organs, body fluids, embryos, and body excretory substances. +","false","#Tissue|#OrganismSubstance" "targetDepth","The targeted read depth prior to sequencing.","false","#" -"tissue","A tissue is a mereologically maximal collection of cells that together perform physiological function.","false","#TissueEnum" diff --git a/docs/templates/ScRNASeq_Template.csv b/docs/templates/ScRNASeq_Template.csv index 46ebe6c7..a112e0e9 100644 --- a/docs/templates/ScRNASeq_Template.csv +++ b/docs/templates/ScRNASeq_Template.csv @@ -1,8 +1,8 @@ "Field","Description","Required","ValidRange" "Component","Type of metadata template; provide the same one for all items/rows.","true","#" "assay","The technology used to generate the data in this file.","true","#AssayEnum" -"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtype" -"dataType","A type of data -- experimental, clinical, or other. Most typically refers to a high-level data type that can be related to an assay type. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. +"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtypeEnum" +"dataType","Links an entity to data types that the entity represents/contains. This is closely tied to the assay property. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. ","true","#Data|#Metadata" "fileFormat","Defined format of the data file, typically corresponding to extension, but sometimes indicating more general group of files produced by the same tool or software","true","#FileFormatEnum" "individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","true","#" @@ -24,7 +24,8 @@ "batchID","Batch identifier, can be used in any context where added batch information is helpful, such as different sequencing runs or collection times.","false","#" "cellID","Also known as cell barcode, this value can be added for single-cell experiments to identify data at the cell level.","false","#" "cellType","A cell type is a distinct morphological or functional form of cell.","false","#Cell" -"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","false","#DiagnosisEnum" +"comments","Brief free-text comments that may also be important to understanding the resource.","false","#" +"diagnosis","Diagnosis for the individual given signs and symptoms. Use the most specific diagnosis term that applies.","false","#DiagnosisEnum" "dissociationMethod","Procedure by which a biological specimen is dissociated into individual cells or a cell suspension","false","#DissociationMethodEnum" "isCellLine","Whether or not sample source is a cell line (Yes; No)","false","#BooleanEnum" "libraryPrep","The general strategy by which the library was prepared","false","#LibraryPrepEnum" @@ -32,6 +33,7 @@ "nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known.","false","#Genotype|#UnknownEnum" "nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","false","#Genotype|#UnknownEnum" "nucleicAcidSource","Source of the extracted nucleic acid used in the experiment","false","#NucleicAcidSourceEnum" +"organ","A unique macroscopic (gross) anatomic structure that performs specific functions. It is composed of various tissues. An organ is part of an anatomic system or a body region.","false","#OrganEnum" "parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor that was subsectioned into several samples. The parentSpecimenID can be the same as specimenID when there is no subsectioning. ","false","#" "readDepth","If available, the coverage statistic as output from bedtools coverage or samtools stats.","false","#" diff --git a/docs/templates/Source_Code_Template.csv b/docs/templates/Source_Code_Template.csv index 5b507101..f190b55a 100644 --- a/docs/templates/Source_Code_Template.csv +++ b/docs/templates/Source_Code_Template.csv @@ -1,8 +1,8 @@ "Field","Description","Required","ValidRange" -"title","Title of a resource.","true","#" +"title","Title of a resource.","true","#string" "author","The author of the resource; preferably use an ORCID ID, GitHub profile link, etc., if available and a text name if not.","false","#" "citation","Citation (e.g. doi) that usage of data or resource should be cited with.","false","#" "documentation","URL to any documentation describing the resource and its use.","false","#" -"license","Link to a license or name of license applicable for the resource.","false","#" +"license","Link to a license or name of license applicable for the resource.","false","#string" "programmingLanguage","A computer programming language","false","#" "runtimePlatform","Runtime platform or script interpreter dependencies (e.g. Java v1, Python 2.3).","false","#" diff --git a/docs/templates/WES_Template.csv b/docs/templates/WES_Template.csv index ed63f59f..66541b45 100644 --- a/docs/templates/WES_Template.csv +++ b/docs/templates/WES_Template.csv @@ -1,8 +1,8 @@ "Field","Description","Required","ValidRange" "Component","Type of metadata template; provide the same one for all items/rows.","true","#" "assay","The technology used to generate the data in this file.","true","#AssayEnum" -"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtype" -"dataType","A type of data -- experimental, clinical, or other. Most typically refers to a high-level data type that can be related to an assay type. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. +"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtypeEnum" +"dataType","Links an entity to data types that the entity represents/contains. This is closely tied to the assay property. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. ","true","#Data|#Metadata" "fileFormat","Defined format of the data file, typically corresponding to extension, but sometimes indicating more general group of files produced by the same tool or software","true","#FileFormatEnum" "individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","true","#" @@ -20,12 +20,14 @@ "ageUnit","A time unit that can be used with a given age value, e.g. years.","false","#TimeUnit" "aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID.","false","#" "batchID","Batch identifier, can be used in any context where added batch information is helpful, such as different sequencing runs or collection times.","false","#" -"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","false","#DiagnosisEnum" +"comments","Brief free-text comments that may also be important to understanding the resource.","false","#" +"diagnosis","Diagnosis for the individual given signs and symptoms. Use the most specific diagnosis term that applies.","false","#DiagnosisEnum" "libraryPrep","The general strategy by which the library was prepared","false","#LibraryPrepEnum" "modelSystemName","A group of presumed common ancestry with clear-cut physiological but usually not morphological distinctions such as an animal model or cell line. EXAMPLE(S): HEK293 (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","false","#CellLineModel|#MouseModel" "nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known.","false","#Genotype|#UnknownEnum" "nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","false","#Genotype|#UnknownEnum" "nucleicAcidSource","Source of the extracted nucleic acid used in the experiment","false","#NucleicAcidSourceEnum" +"organ","A unique macroscopic (gross) anatomic structure that performs specific functions. It is composed of various tissues. An organ is part of an anatomic system or a body region.","false","#OrganEnum" "parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor that was subsectioned into several samples. The parentSpecimenID can be the same as specimenID when there is no subsectioning. ","false","#" "readDepth","If available, the coverage statistic as output from bedtools coverage or samtools stats.","false","#" @@ -33,7 +35,8 @@ "readPair","The read of origin, Read 1 or Read 2","false","#" "runType","Sequencing run type.","false","#RunTypeEnum" "sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","false","#SexEnum|#UnknownEnum|#NotApplicableEnum" +"specimenType","The type of a material sample taken from a biological entity for testing, diagnostic, propagation, treatment or research purposes. This includes particular types of cellular molecules, cells, tissues, organs, body fluids, embryos, and body excretory substances. +","false","#Tissue|#OrganismSubstance" "targetCaptureKitID","A unique identifier for the kit used to construct a genomic library using target capture-based techniques, which should be composed of the vendor name, kit name and kit version. ","false","#" "targetDepth","The targeted read depth prior to sequencing.","false","#" -"tissue","A tissue is a mereologically maximal collection of cells that together perform physiological function.","false","#TissueEnum" diff --git a/docs/templates/WGS_Template.csv b/docs/templates/WGS_Template.csv index c73edbd6..ba985fbb 100644 --- a/docs/templates/WGS_Template.csv +++ b/docs/templates/WGS_Template.csv @@ -1,8 +1,8 @@ "Field","Description","Required","ValidRange" "Component","Type of metadata template; provide the same one for all items/rows.","true","#" "assay","The technology used to generate the data in this file.","true","#AssayEnum" -"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtype" -"dataType","A type of data -- experimental, clinical, or other. Most typically refers to a high-level data type that can be related to an assay type. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. +"dataSubtype","Further qualification of dataType, which may be used to indicate the state of processing of the data, aggregation of the data, or presence of metadata.","true","#DataSubtypeEnum" +"dataType","Links an entity to data types that the entity represents/contains. This is closely tied to the assay property. For example, a file of dataType `genomicVariants` might have an assay value of `whole genome sequencing`. ","true","#Data|#Metadata" "fileFormat","Defined format of the data file, typically corresponding to extension, but sometimes indicating more general group of files produced by the same tool or software","true","#FileFormatEnum" "individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","true","#" @@ -20,12 +20,14 @@ "ageUnit","A time unit that can be used with a given age value, e.g. years.","false","#TimeUnit" "aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID.","false","#" "batchID","Batch identifier, can be used in any context where added batch information is helpful, such as different sequencing runs or collection times.","false","#" -"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","false","#DiagnosisEnum" +"comments","Brief free-text comments that may also be important to understanding the resource.","false","#" +"diagnosis","Diagnosis for the individual given signs and symptoms. Use the most specific diagnosis term that applies.","false","#DiagnosisEnum" "libraryPrep","The general strategy by which the library was prepared","false","#LibraryPrepEnum" "modelSystemName","A group of presumed common ancestry with clear-cut physiological but usually not morphological distinctions such as an animal model or cell line. EXAMPLE(S): HEK293 (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","false","#CellLineModel|#MouseModel" "nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known.","false","#Genotype|#UnknownEnum" "nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","false","#Genotype|#UnknownEnum" "nucleicAcidSource","Source of the extracted nucleic acid used in the experiment","false","#NucleicAcidSourceEnum" +"organ","A unique macroscopic (gross) anatomic structure that performs specific functions. It is composed of various tissues. An organ is part of an anatomic system or a body region.","false","#OrganEnum" "parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor that was subsectioned into several samples. The parentSpecimenID can be the same as specimenID when there is no subsectioning. ","false","#" "readDepth","If available, the coverage statistic as output from bedtools coverage or samtools stats.","false","#" @@ -33,5 +35,6 @@ "readPair","The read of origin, Read 1 or Read 2","false","#" "runType","Sequencing run type.","false","#RunTypeEnum" "sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","false","#SexEnum|#UnknownEnum|#NotApplicableEnum" +"specimenType","The type of a material sample taken from a biological entity for testing, diagnostic, propagation, treatment or research purposes. This includes particular types of cellular molecules, cells, tissues, organs, body fluids, embryos, and body excretory substances. +","false","#Tissue|#OrganismSubstance" "targetDepth","The targeted read depth prior to sequencing.","false","#" -"tissue","A tissue is a mereologically maximal collection of cells that together perform physiological function.","false","#TissueEnum"