From e8a62c4233400f2102e32fc32ac66d4c68a7e875 Mon Sep 17 00:00:00 2001 From: anngvu <32753274+anngvu@users.noreply.github.com> Date: Mon, 20 Jun 2022 18:42:26 -0600 Subject: [PATCH] Genomics templates and docs updates (#166) * Add key for issue #158 * Add processing module w/ initial workflow attributes * Fix non-unique ids in new props * Update template documentation code Templates are documented more accurately and reflect use of dependency expansion. Moreover, the doc function previously built all template assets by default, but now templates to generate assets for have to be specified more intentionally. * Import data types from GDC for processed data templates * Add new data types to property valid values * Add seq data properties per reopened issue #126 * Pull in workflowLink whenever workflow is mentioned via dependency def * Update genomics templates and add processed variants (WIP) * Revise internal Range assignment for dataSubtype * Regenerate all assets * Add WES-specific prop and regen docs again * Add changes * Import additional props from GDC * Add changes * Import class term for germline variants data * Add changes Co-authored-by: nf-osi[bot] --- .gitattributes | 3 + NF.csv | 94 +- NF.jsonld | 1059 +++++++++++++++-- docs/docTemplate.R | 93 +- docs/index.Rmd | 140 ++- docs/index.html | 232 ++-- docs/templates/Behavioral_Assay_Template.csv | 12 - docs/templates/Biospecimen_Template.csv | 4 - .../Biospecimen_Template_Normalized.csv | 13 - docs/templates/Clinical_Assay_Template.csv | 35 +- .../Clinical_Assay_Template_Extended.csv | 15 - docs/templates/Epigenetics_Assay_Template.csv | 38 +- docs/templates/Genomics_Assay_Template.csv | 41 +- .../Genomics_Assay_Template_Extended.csv | 16 - .../Genomics_Assay_Template_Normalized.csv | 13 - docs/templates/Imaging_Assay_Template.csv | 33 +- .../Imaging_Assay_Template_Extended.csv | 16 - docs/templates/Individual_Template.csv | 10 - docs/templates/MRI_Assay_Template.csv | 37 +- .../templates/PDX_Genomics_Assay_Template.csv | 17 - .../templates/Patient_Timepoints_Template.csv | 10 +- .../Pharmacokinetics_Assay_Template.csv | 40 +- .../Plate_Based_Reporter_Assay_Template.csv | 38 +- .../Processed_Aligned_Reads_Template.csv | 45 + .../Processed_Expression_Template.csv | 23 + .../Processed_Variant_Calls_Template.csv | 22 + docs/templates/Proteomics_Assay_Template.csv | 37 +- docs/templates/Protocol_Template.csv | 8 - docs/templates/RNASeq_Template.csv | 43 + docs/templates/ScRNASeq_Template.csv | 42 + docs/templates/Source_Code_Template.csv | 6 +- docs/templates/Update_Milestone_Report.csv | 5 - docs/templates/WES_Template.csv | 43 + docs/templates/WGS_Template.csv | 42 + modules/Assay/annotationProperty.csv | 9 +- modules/Data/Data_Class.csv | 9 +- modules/Data/annotationProperty.csv | 5 +- modules/Processing/annotationProperty.csv | 13 + modules/Template/Template.csv | 61 +- 39 files changed, 1953 insertions(+), 469 deletions(-) create mode 100644 .gitattributes delete mode 100644 docs/templates/Behavioral_Assay_Template.csv delete mode 100644 docs/templates/Biospecimen_Template.csv delete mode 100644 docs/templates/Biospecimen_Template_Normalized.csv delete mode 100644 docs/templates/Clinical_Assay_Template_Extended.csv delete mode 100644 docs/templates/Genomics_Assay_Template_Extended.csv delete mode 100644 docs/templates/Genomics_Assay_Template_Normalized.csv delete mode 100644 docs/templates/Imaging_Assay_Template_Extended.csv delete mode 100644 docs/templates/Individual_Template.csv delete mode 100644 docs/templates/PDX_Genomics_Assay_Template.csv create mode 100644 docs/templates/Processed_Aligned_Reads_Template.csv create mode 100644 docs/templates/Processed_Expression_Template.csv create mode 100644 docs/templates/Processed_Variant_Calls_Template.csv delete mode 100644 docs/templates/Protocol_Template.csv create mode 100644 docs/templates/RNASeq_Template.csv create mode 100644 docs/templates/ScRNASeq_Template.csv delete mode 100644 docs/templates/Update_Milestone_Report.csv create mode 100644 docs/templates/WES_Template.csv create mode 100644 docs/templates/WGS_Template.csv create mode 100644 modules/Processing/annotationProperty.csv diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..5dc46e6b --- /dev/null +++ b/.gitattributes @@ -0,0 +1,3 @@ +* text=auto eol=lf +*.{cmd,[cC][mM][dD]} text eol=crlf +*.{bat,[bB][aA][tT]} text eol=crlf \ No newline at end of file diff --git a/NF.csv b/NF.csv index 69fb71e2..0f72e9b4 100644 --- a/NF.csv +++ b/NF.csv @@ -196,6 +196,7 @@ Vevo 3100 Imaging System,"(From vendor) A micro-ultrasound imaging system for an drugScreenType,String describing general class of drug screen,"singleMolecule, smallMoleculeLibraryScreen, combinationLibraryScreen, combinationScreen",,FALSE,,compoundScreen,,,,drugScreenType,Property,Assay,annotationProperty,,,, assay,The technology used to generate the data in this file,"elevated plus maze test, open field test, rotarod performance test, mRNAcounts, high content screen, Immunocytochemistry, immunofluorescence, autoradiography, electrochemiluminescence, Real Time PCR, in vivo tumor growth, scale, Blood Chemistry Measurement, in vivo bioluminescence, immunohistochemistry, NOMe-Seq, FIA-MSMS, UPLC-MSMS, HPLC-MSMS, liquid chromatography-electrochemical detection, rnaSeq, mirnaSeq, LC-MSMS, LC-MS, lncrnaSeq, Whole Exome Sequencing, Sanger sequencing, ChIPSeq, rnaArray, snpArray, methylationArray, mirnaArray, bisulfiteSeq, ATACSeq, HI-C, errBisulfiteSeq, ISOSeq, westernBlot, wholeGenomeSeq, polymeraseChainReaction, cellViabilityAssay, atomicForceMicroscopy, brightfieldMicroscopy, tractionForceMicroscopy, nextGenerationTargetedSequencing, jumpingLibrary, MIB/MS, scCGIseq, MudPIT, questionnaire, DNA optical mapping, oxBS-Seq, Ribo-Seq, Positron Emission Tomography, RPPA, ELISA, LTP, LFP, whole-cell patch clamp, sandwich ELISA, Laser Speckle Imaging, Genotyping, TMT quantitation, label free mass spectrometry, cell count, reporter gene assay, Single Cell RNA Sequencing, spatial transcriptomics, Conventional MRI, Functional MRI, Magnetic Resonance Spectroscopy, 2D Incucyte, 2D CellTiter-Glo, 3D microtissue viability, in vivo PDX viability, 2D AlamarBlue fluorescence, 2D AlamarBlue absorbance, rheometry, FTIR Spectroscopy, differential scanning calorimetry, Gel filtration chromatography, Massively Parallel Reporter Assay,Riccardi and Ablon scales,Spatial Frequency Domain Imaging,Optical Coherence Tomography",,TRUE,,experimentalData,,,,assayType,Property,Assay,annotationProperty,,Assay,one, platform,"A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","HiSeq3000, HiSeq2500, HiSeq4000, NextSeq500, HiSeq2000, MiSeq, Zeiss LSM 980, Affy5.0, Affy6.0, PacBioRSII, GAIIx, Illumina_HumanOmni1-Quadv1.0, Illumina_1M, Illumina_h650, Illumina_Omni2pt5M, Illumina_Omni5M, Illumina MouseWG-6 v2.0 expression beadchip, Perlegen300Karray, Agilent44Karray, IlluminaWholeGenomeDASL, IlluminaHumanHap300, NanostringnCounter, LTQOrbitrapXL, IlluminaHumanMethylation450, Illumina Infinium MethylationEPIC BeadChip, AffymetrixU133AB, Affymetrix Human Gene 1.0 ST Array, AffymetrixU133Plus2, HiSeqX, Bionano Irys, Infinium HumanOmniExpressExome, NextSeq 550, NextSeq 1000, NextSeq 2000, PacBio Sequel IIe System, PacBio Sequel II System, NanostringGeoMx, LI-COR Odyssey CLx, Spectramax M Series, Olympus DP80, Orbitrap Fusion Lumos Tribrid, Illumina NovaSeq 6000, Chromium X,EnVision 2103 Multiplate Reader,Vectra H1 3D Imaging System,Vevo 3100 Imaging System,10x Visium Spatial Gene Expression",,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=read_group&anchor=platform,experimentalData,,,,platform,Property,Assay,annotationProperty,,Platform,, +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.",,,TRUE,http://purl.obolibrary.org/obo/NCIT_C177583,experimentalData,,,,targetCaptureKitID,Property,Assay,annotationProperty,,,,"For WES processing, the target BED used could be provided based on the target capture kit." libraryID,,,,TRUE,,experimentalData,,,,libraryID,Property,Assay,annotationProperty,,,, assayTarget,The HUGO gene symbol that represents the target analyte assayed.,,,FALSE,Sage Bionetworks,experimentalData,,,,assayTarget,Property,Assay,annotationProperty,,,, proteinExtractSource,Source of the extracted protein used in the experiment,"cell lysate, nuclei, mitochondria, cytoplasm",,TRUE,http://purl.obolibrary.org/obo/OBI_0000894,experimentalData,,,,proteinExtractSource,Property,Assay,annotationProperty,,,, @@ -211,9 +212,11 @@ libraryPrep,The general strategy by which the library was prepared,"rRNAdepletio libraryPreparationMethod,Method by which library was prepared,"10x, CEL-seq, Drop-Seq, Smart-seq2, TruSeq, Smart-seq4, Omni-ATAC, NEBNext mRNA Library Prep Reagent Set for Illumina, IDT xGen Exome Research Panel, TruSeq standard total RNA library kit, Illumina TruSeq DNA Nano, KAPA HyperPrep Kit PCR-free,KAPA RNA HyperPrep Kit with RiboErase (HMR),GTAC@WUSTL in-house prep",,FALSE,,ngs,,,,libraryPreparationMethod,Property,Assay,annotationProperty,ngsParameter,Library_Preparation_Method,, nucleicAcidSource,Source of the extracted nucleic acid used in the experiment,"bulk cell, single cell, bulk nuclei, single nucleus, mitochondria",,FALSE,Sage Bionetworks,ngs,,,,nucleicAcidSource,Property,Assay,annotationProperty,ngsParameter,Nucleic_Acid_Source,, dissociationMethod,Procedure by which a biological specimen is dissociated into individual cells or a cell suspension,"10x_v2, FACS, Fluidigm C1, drop-seq, inDrop, mouth pipette, bulk, enzymatic, mechanical, none",,FALSE,https://www.ebi.ac.uk/ols/ontologies/efo/terms?iri=http%3A%2F%2Fwww.ebi.ac.uk%2Fefo%2FEFO_0009088,ngs,,,,dissociationMethod,Property,Assay,annotationProperty,ngsParameter,Dissociation_Method,, -readLength,Number of base pairs (bp) sequenced for a read,,,FALSE,,ngs,,,,readLength,DataProperty,Assay,annotationProperty,ngsParameter,,, -readDepth,"If available, coverage statistic as output from bedtools coverage or samtools stats.",,,FALSE,Sage Bionetworks,ngs,,,,readDepth,DataProperty,Assay,annotationProperty,ngsParameter,,, -isPairedEnd,"(Legacy/deprecated annotation) Whether or not is paired-end sequencing (Yes; No). Note that this can be inferred as 'Yes' when runType=pairedEnd; current templates actually use runType to capture this info.","Yes, No",,FALSE,,ngs,,,,isPairedEnd,DataProperty,Assay,annotationProperty,ngsParameter,,, +readLength,Number of base pairs (bp) sequenced for a read,,,TRUE,,ngs,,,,readLength,DataProperty,Assay,annotationProperty,ngsParameter,,, +readDepth,"If available, the coverage statistic as output from bedtools coverage or samtools stats.",,,FALSE,Sage Bionetworks,ngs,,,,readDepth,DataProperty,Assay,annotationProperty,ngsParameter,,, +isPairedEnd,(Legacy/deprecated annotation) Whether or not is paired-end sequencing (Yes; No). Note that this can be inferred as 'Yes' when runType=pairedEnd; current templates actually use runType to capture this info.,"Yes, No",,FALSE,,ngs,,,,isPairedEnd,DataProperty,Assay,annotationProperty,ngsParameter,,, +totalReads,"If available, the total number of reads collected from samtools.",,,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads&anchor=total_reads,ngs,,,,totalReads,DataProperty,Assay,annotationProperty,ngsParameter,,, +targetDepth,"The targeted read depth prior to sequencing.",,,FALSE,https://data.humantumoratlas.org/standards/bulkrnaseq#TargetDepth,ngs,,,,targetDepth,DataProperty,Assay,annotationProperty,ngsParameter,,, head,The head is the anterior-most division of the body.,"","",FALSE,http://purl.obolibrary.org/obo/UBERON_0000033,bodyPart,,"","",Head,Class,Biosample,Body_Part,Body_Part,"","","" lymph node,A bean-shaped organ surrounded by a connective tissue capsule.,"","",FALSE,http://purl.obolibrary.org/obo/NCIT_C12745,organ,,"","",Lymph_Node,Class,Biosample,Body_Part,Organ,"","","" kidney,One of the two bean-shaped organs located on each side of the spine in the retroperitoneum.,"","",FALSE,http://purl.obolibrary.org/obo/NCIT_C12415,organ,,"","",Kidney,Class,Biosample,Body_Part,Organ,"","","" @@ -521,8 +524,13 @@ raw counts,The number or amount of something.,"",assay,FALSE,http://purl.obolibr Volume,The amount of three dimensional space occupied by an object or the capacity of a space or container.,"",assay,FALSE,http://purl.obolibrary.org/obo/NCIT_C25335,dataType,,"","",Volume,Class,Data,Data_Class,"","","","" Weight,The vertical force exerted by a mass as a result of gravity.,"",assay,FALSE,http://purl.obolibrary.org/obo/NCIT_C25208,dataType,,"","",Weight,Class,Data,Data_Class,"","","","" Pharmacokinetic Study,"A study of the process by which a drug is absorbed, distributed, metabolized, and eliminated by the body.","",assay,FALSE,http://purl.obolibrary.org/obo/NCIT_C49663,dataType,,"","",Pharmacokinetic_Study,Class,Data,Data_Class,"","","","" -genomicVariants,"Genomic alterations, including single nucleotide polymorphisms, short indels and structural variants, in a genome sequence.","",assay,FALSE,https://www.ebi.ac.uk/ols/ontologies/edam/terms?iri=http%3A%2F%2Fedamontology.org%2Foperation_3227,dataType,,"","",Genomic_Variants,Class,Data,Data_Class,"","","","" -behavior process,"The action, reaction, or performance of an organism in response to external or internal stimuli.","",assay,FALSE,http://purl.obolibrary.org/obo/NBO_0000313,dataType,,"","",Behavior_Process,Class,Data,Data_Class,"","","","" +genomicVariants,"Genomic alterations, including single nucleotide polymorphisms, short indels and structural variants. Use more specific term if possible, esp. if data is only of one specific subset.","",assay,FALSE,https://www.ebi.ac.uk/ols/ontologies/edam/terms?iri=http%3A%2F%2Fedamontology.org%2Foperation_3227,dataType,,"","",Genomic_Variants,Class,Data,Data_Class,"","","","" +AlignedReads,"Aligned reads output from alignment workflows","",assay,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads,dataType,,"","",Aligned_Reads,Class,Data,Data_Class,"","","","" +SomaticVariants,"Specifically genomic variants data that includes somatic variants and excludes germline variants","",assay,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=simple_somatic_mutation,dataType,,"","",Somatic_Variants,Class,Data,Data_Class,"",,"","" +AnnotatedSomaticVariants,"Specifically genomic variants data that includes somatic variants with annotations added from some annotation workflow","",assay,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=annotated_somatic_mutation,dataType,,"","",Annotated_Somatic_Variants,Class,Data,Data_Class,"","","","" +GermlineVariants,"Specifically genomic variants data that includes called germline variants","",assay,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=simple_germline_variation,dataType,,"","",Germline_Variants,Class,Data,Data_Class,"","","","" +StructuralVariants,"Specifically genomic variants data classified as structural variants, which may be derived from specialized variant calling workflows","",assay,FALSE,,dataType,,"","",Structural_Variants,Class,Data,Data_Class,"","","","" +behavior process,"The action, reaction, or performance of an organism in response to external or internal stimuli.","",assay,FALSE,hhttps://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=structural_variation,dataType,,"","",Behavior_Process,Class,Data,Data_Class,"","","","" metabolomics,"The systematic study of metabolites, the chemical processes they are involved, and the chemical fingerprints of specific cellular processes in a whole cell, tissue, organ or organism.","",assay,FALSE,http://edamontology.org/topic_3172,dataType,,"","",Metabolomics,Class,Data,Data_Class,"","","","" image,Biological or biomedical data that has been rendered into an image.,"",assay,FALSE,https://www.ebi.ac.uk/ols/ontologies/edam/terms?iri=http%3A%2F%2Fedamontology.org%2Fdata_2968,dataType,,"","",Image,Class,Data,Data_Class,"","","","" geneExpression,The analysis of levels and patterns of synthesis of gene products (proteins and functional RNA) including interpretation in functional terms of gene expression data.,"",assay,FALSE,https://www.ebi.ac.uk/ols/ontologies/edam/terms?iri=http%3A%2F%2Fedamontology.org%2Ftopic_0203,dataType,,"","",Gene_Expression,Class,Data,Data_Class,"","","","" @@ -660,9 +668,10 @@ protocol,"A plan specification which has sufficient level of detail and quantita curatedDataType,The type of information being curated.,"reference sequence, gene symbol, clinical data, gene function, chemical descriptor",,TRUE,,curatedData,,,,curatedDataType,Property,Data,annotationProperty,,,, referenceSet,"A set of references (e.g., canonical assembled contigs) which defines a common coordinate space for comparing reference-aligned experimental data.","GRCh38, GRCh37, MMUL1.0, HRC",,TRUE,,curatedData,,,,referenceSet,Property,Data,annotationProperty,,,, reference sequence,Syntactic sequences that has a role as reference of an annotation.,,,FALSE,http://rdf.biosemantics.org/ontologies/rsa#ReferenceSequence,curatedDataType,,,,referenceSequence,Property,Data,annotationProperty,,,, -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.","normalized, dataMatrix, raw, processed, metadata, representative",,TRUE,,experimentalData,,,,dataSubtype,Property,Data,annotationProperty,,Data,one, +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.","normalized, dataMatrix, raw, processed, metadata, representative",,TRUE,,experimentalData,,,,dataSubtype,Property,Data,annotationProperty,,Data_Level,one, metadataType,"For files of dataSubtype: metadata, a description of the type of metadata in the file.","individual, biospecimen, assay, data dictionary, manifest, protocol",,FALSE,,experimentalData,,,,metadataType,Property,Data,annotationProperty,,,, -dataType,"A type of experimental, clinical, or other data. This typically refers to a high-level data type, that is paired with a specific assay. For example, a file of dataType of """"genomicVariants"""" might have an assay value of """"whole genome sequencing"""". ","Volume, Weight, Pharmacokinetic Study, genomicVariants, behavior process, metabolomics, image, geneExpression, isoformExpression, proteomics, kinomics, drugScreen, drugCombinationScreen, cellularPhysiology, chromatinActivity, surveyData, network, clinical, immunoassay, electrophysiology, raw counts, mask image",dataSubtype,TRUE,,experimentalData,,,,dataType,Property,Data,annotationProperty,,Data,one, +dataType,"A type of experimental, clinical, or other data. This 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`.","Volume, Weight, Pharmacokinetic Study, genomicVariants,behavior process, metabolomics, image, geneExpression, isoformExpression, proteomics, kinomics, drugScreen, drugCombinationScreen, cellularPhysiology, chromatinActivity, surveyData, network, clinical, immunoassay, electrophysiology, raw counts, mask image,AlignedReads,SomaticVariants,AnnotatedSomaticVariants,StructuralVariants,GermlineVariants",dataSubtype,TRUE,,experimentalData,,,,dataType,Property,Data,annotationProperty,,Data,one, +expressionUnit,"Measure used for transcript expression quantification","TPM,RPKM,FPKM,Counts,Other",,TRUE,,experimentalData,,,,expressionUnit,DataProperty,Data,annotationProperty,,,, failedQC,Whether the sample or data failed QC checks (Yes; No),"Yes, No",,TRUE,,experimentalData,,,,failedQC,DataProperty,Data,annotationProperty,,,, Filename,The name of the file.,,"entityId,fileFormat",TRUE,Sage Bionetworks,NF,,,,fileName,Class,Data,annotationProperty,fileName,,one,Automatically filled when using the curator app. programmingLanguage,A computer programming language,"Python, R, MATLAB, Java, C, C++, C#, Javascript, bash",,FALSE,Sage Bionetworks,,,,,programmingLanguage,Property,Data,annotationProperty,ngsParameter,,, @@ -716,31 +725,50 @@ genePerturbationTechnology,Technology used to perform gene perturbation,"RNAi, C genePerturbed,The HUGO gene symbol for the gene that is perturbed.,,"genePerturbationType,genePerturbationTechnology",FALSE,Sage Bionetworks,sageCommunity,,,,genePerturbed,Property,Assay,annotationProperty,experimentProperty,,, JAX,The Jackson Laboratory,"","",FALSE,https://www.jax.org,individualIdSource,,"","",JAX,Class,Other,Organization,"","","","" sageCommunity,"","","",FALSE,"","",,"","","",Class,Other,Organization,"","","","" +workflow,"Name and version of the workflow used to generate/analyze the data",,workflowLink,FALSE,,,,,,workflow,Property,Processing,annotationProperty,,,, +workflowLink,"Workflow URL reference",,,FALSE,,,,,,workflowLink,Property,Processing,annotationProperty,,,, +genomicReference,"Version of genome reference used for alignment in processing workflow",,,FALSE,,,,,,genomicReference,Property,Processing,annotationProperty,,,, +averageInsertSize,"Average insert size as reported by samtools",,,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads&anchor=average_insert_size,,,,,averageInsertSize,Property,Processing,annotationProperty,,,, +averageReadLength,"Average read length collected from samtools",,,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads&anchor=average_read_length,,,,,averageReadLength,Property,Processing,annotationProperty,,,, +averageBaseQuality,"Average base quality collected from samtools",,,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads&anchor=average_base_quality,,,,,averageBaseQuality,Property,Processing,annotationProperty,,,, +pairsOnDifferentChr,"Pairs on different chromosomes collected from samtools",,,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads&anchor=pairs_on_diff_chr,,,,,pairsOnDifferentChr,Property,Processing,annotationProperty,,,, +readsDuplicatedPercent,"Percent of duplicated reads collected from samtools",,,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads&anchor=proportion_reads_duplicated,,,,,readsDuplicatedPercent,Property,Processing,annotationProperty,,,, +readsMappedPercent,"Percent of mapped reads collected from samtools",,,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads&anchor=proportion_reads_mapped,,,,,readsMappedPercent,Property,Processing,annotationProperty,,,, +meanCoverage,"Mean coverage for whole genome sequencing, or mean target coverage for whole exome and targeted sequencing, collected from Picard Tools",,,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads&anchor=mean_coverage,,,,,meanCoverage,Property,Processing,annotationProperty,,,, +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,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads&anchor=proportion_coverage_10x,,,,,proportionCoverage10x,Property,Processing,annotationProperty,,,, +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,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads&anchor=proportion_coverage_30x,,,,,proportionCoverage30x,Property,Processing,annotationProperty,,,, Component,"Category of metadata manifest; provide the same one for all items/rows.",,,TRUE,https://w3id.org/biolink/vocab/category,,,,,,,,,,,, -genomicsAssayTemplate_Normalized,"Generic template for describing data from a genomic type assay (RNA-seq, Exome-seq, etc) WITHOUT full individual and biospecimen data. To link individual and biospecimen metadata, an additional “biospecimenTemplate_Default” must be additionally completed with either specimenID or aliquotID available for joining. This is a two-step template.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,specimenID,aliquotID,runType,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,Genomics_Assay_Template_Normalized,Class,Template,Template,Assay_Template,,, -genomicsAssayTemplate,"Generic denormalized template for describing data from a genomic type assay (RNA-seq, Exome-seq, etc) along with individual, biospecimen and experimental metadata. This is a one-step template.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,runType,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,Genomics_Assay_Template,Class,Template,Template,Assay_Template,,, -genomicsAssayTemplate_Extended,"Template for describing data from a genomic type assay (RNA-seq, Exome-seq, etc) with extended properties for capturing additional metadata such as gene perturbation parameters or experimental conditions and time points. This is a one-step template.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,runType,libraryPrep,genePerturbed,comments",TRUE,Sage Bionetworks,template,,,,Genomics_Assay_Template_Extended,Class,Template,Template,Assay_Template,,, -imagingAssayTemplate,"Generic template for describing data from an imaging type assay (IHC, etc). This is a one-step template.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,assay,platformTarget,individualID,parentSpecimenID,comments",TRUE,Sage Bionetworks,template,,,,Imaging_Assay_Template,Class,Template,Template,Assay_Template,,, -imagingAssayTemplate_Extended,"Template for describing data from an imaging type assay (IHC, etc) with extended properties for capturing additional metadata such as gene perturbation parameters or experimental conditions and time points.. This is a one-step template.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,assay,platformTarget,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,genePerturbed,comments",TRUE,Sage Bionetworks,template,,,,Imaging_Assay_Template_Extended,Class,Template,Template,Assay_Template,,, -MRIAssayTemplate,Generic template for describing data from an MRI assay. This is a one-step template.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,MRISequence,comments",TRUE,Sage Bionetworks,template,,,,MRI_Assay_Template,Class,Template,Template,Assay_Template,,, -epigeneticsAssayTemplate,Generic template for describing data from an epigenetics assay. This is a one-step template.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,Epigenetics_Assay_Template,Class,Template,Template,Assay_Template,,, -pharmacokineticsAssayTemplate,Generic template for describing data from a pharmacokinetics assay. This is a one-step template.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,assay,platformTarget,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,genePerturbed,comments",TRUE,Sage Bionetworks,template,,,,Pharmacokinetics_Assay_Template,Class,Template,Template,Assay_Template,,, -proteomicsAssayTemplate,Generic template for describing data from a proteomics assay. Note that specialized proteomics assays may have their own template to capture more detailed information. This is a one-step template.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,proteinExtractSource,comments ",TRUE,Sage Bionetworks,template,,,,Proteomics_Assay_Template,Class,Template,Template,Assay_Template,,, -plateBasedReporterAssayTemplate,Generic template for describing data from a plate-based reporter assay. This is a one-step template.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,assay,platformTarget,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,reporterGene,reporterSubstance,comments",TRUE,Sage Bionetworks,template,,,,Plate_Based_Reporter_Assay_Template,Class,Template,Template,Assay_Template,,, -patientTimepointsTemplate,Template for capturing individual-level metadata with time points. Do not use for data file annotation.,,"Component,individualID,experimentalTimepoint",TRUE,Sage Bionetworks,template,,,,Patient_Timepoints_Template,Class,Template,Template,Non_Assay_Template,,, -clinicalAssayTemplate,"Annotation template for simple endpoint data from clinical assays often used in diagnostic practice or clinical trials; may include repeated measures and a treatment/intervention context. Examples include bloodwork results (creatine assay, serum antibody assay), tumor size measurements, or medication adherence. Note that clinical data are from human individuals, therefore species should be “human”. ",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,comments",TRUE,Sage Bionetworks,template,,,,Clinical_Assay_Template,Class,Template,Template,Assay_Template,,, -clinicalAssayTemplate_Extended,Annotation template for simple endpoint data from clinical assays often used in diagnostic practice or clinical trials; may include repeated measures and a treatment/intervention context. Extended to capture additional drug/treatment parameters.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,compoundName,compoundDose,comments",TRUE,Sage Bionetworks,template,,,,Clinical_Assay_Template_Extended,Class,Template,Template,Assay_Template,,, -behavioralAssayTemplate,"Generic template for describing data from behavioral assays such as “adaptive n-back task” (for humans) or “shock-probe defensive burying test” (for mice). If another modality is used as part of the behavioral assay, e.g. fMRI, that data can be linked.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,experimentalCondition,experimentalTimepoint,comments",TRUE,Sage Bionetworks,template,,,,Behavioral_Assay_Template,Class,Template,Template,Assay_Template,,, -sourceCodeTemplate,Template for describing scripts or source code files for a software application.,,"Component,Filename,resourceType,programmingLanguage,documentation,runtimePlatform,comments",TRUE,Sage Bionetworks,template,,,,Source_Code_Template,Class,Template,Template,Non_Assay_Template,,, -protocolTemplate,Template for describing a protocol document. (BETA) Adapted from https://bioschema.org/profiles/LabProtocol/0.6-DRAFT-2020_12_08,,"Component,Filename,resourceType,author,citation,license,comments",TRUE,Sage Bionetworks,template,,,,Protocol_Template,Class,Template,Template,Non_Assay_Template,,, -pdxGenomicsAssay,Template for describing PDX assay data that extends genomicsAssay.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,transplantationType,genePerturbed,runType,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,PDX_Genomics_Assay_Template,Class,Template,Template,Assay_Template,,, -updateMilestoneReport,Defines a metadata template for updating milestone report values in NF studies -- currently a supported feature for NTAP and GFF.,,"Component,Filename,resourceType,progressReportNumber",FALSE,Sage Bionetworks,template,,,,Update_Milestone_Report,Class,Template,Template,Non_Assay_Template,,, -template,Parent attribute for the manifest template attributes.,,,FALSE,Sage Bionetworks,template,,,,Template,Class,Template,Template,,,, -individualTemplate,Base template for minimal information describing individual-level data within the NF scope. Not called “patientTemplate_Default” because individuals can be a non-human organism.,"individualID,sex,age,ageUnit,species,diagnosis,nf1Genotype,nf2Genotype","Component,individualID,sex,age,ageUnit,species,diagnosis,nf1Genotype,nf2Genotype",FALSE,Sage Bionetworks,template,,,,Individual_Template,Class,Template,Template,Non_Assay_Template,,, -biospecimenTemplate_Normalized,Base template for describing biospecimen-level data.,"parentSpecimenID,specimenID,aliquotID,organ,tissue,isCellLine,isPrimaryCell,cellType,tumorType,specimenPreparationMethod,modelSystemName","Component,parentSpecimenID,specimenID,aliquotID,organ,tissue,isCellLine,isPrimaryCell,cellType,tumorType,specimenPreparationMethod,modelSystemName",FALSE,Sage Bionetworks,template,,,,Biospecimen_Template_Normalized,Class,Template,Template,Non_Assay_Template,,, -biospecimenTemplate,Denormalized template for describing biospecimen data that includes all individual-level data as well.,,"Component,individualID,parentSpecimenID",FALSE,Sage Bionetworks,template,,,,Biospecimen_Template,Class,Template,Template,Non_Assay_Template,,, -dataFileComponent,Template component for describing a data file resource that extends fileTemplate_Default with required properties dataType and dataSubtype.,"Filename,entityId,fileFormat,resourceType,dataType,dataSubtype","Filename,entityId,fileFormat,resourceType,dataType,dataSubtype",FALSE,Sage Bionetworks,template,,,,Data_File_Component,Class,Template,TemplateComponent,,,, -experimentComponent,Template component for describing core experimental parameters.,"experimentalCondition,experimentalTimepoint","experimentalCondition,experimentalTimepoint",FALSE,Sage Bionetworks,template,,,,Experiment_Component,Class,Template,TemplateComponent,,,, -genePerturbComponent,Template component for adding genetic perturbation metadata. This applies only to some assays and does not make sense with e.g. behavioral assays.,"genePerturbed,genePerturbationType,genePerturbationTechnology","genePerturbed,genePerturbationType,genePerturbationTechnology",FALSE,Sage Bionetworks,template,,,,Gene_Perturb_Component,Class,Template,TemplateComponent,,,, -fileComponent,Template component for describing some file on the NF-OSI Synapse platform.,"Filename,entityId,fileFormat,resourceType","Filename,entityId,fileFormat,resourceType",FALSE,Sage Bionetworks,template,,,,File_Component,Class,Template,TemplateComponent,,,, +genomicsAssayTemplate_Normalized,"Generic template for describing raw data from a genomic type assay (RNA-seq, Exome-seq, etc) WITHOUT full individual and biospecimen data. To link individual and biospecimen metadata, an additional “biospecimenTemplate_Default” must be additionally completed with either specimenID or aliquotID available for joining. This is a two-step template.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,specimenID,aliquotID,runType,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,Genomics_Assay_Template_Normalized,Class,Template,Template,Assay_Template,,, +genomicsAssayTemplate,"Generic denormalized template for describing raw data from a genomic type assay (RNA-seq, Exome-seq, etc) along with individual, biospecimen and experimental metadata. This is a one-step template.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,runType,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,Genomics_Assay_Template,Class,Template,Template,Assay_Template,,, +genomicsAssayTemplate_Extended,"Template for describing raw data from a genomic type assay (RNA-seq, Exome-seq, etc) with extended properties for capturing additional metadata such as gene perturbation parameters or experimental conditions and time points. This is a one-step template.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,runType,libraryPrep,genePerturbed,comments",TRUE,Sage Bionetworks,template,,,,Genomics_Assay_Template_Extended,Class,Template,Template,Assay_Template,,, +WGSTemplate,"Template for describing raw data from Whole Genome Sequencing (WGS)",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,runType,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,WGS_Template,Class,Template,Template,Assay_Template,,, +WESTemplate,"Template for describing raw data from Whole Exome Sequencing (WES)",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,runType,targetCaptureKitID,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,WES_Template,Class,Template,Template,Assay_Template,,, +RNASeqTemplate,"Template for describing raw data from (bulk) RNA-sequencing",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,runType,libraryPrep,targetDepth,comments",TRUE,Sage Bionetworks,template,,,,RNA_Seq_Template,Class,Template,Template,Assay_Template,,, +ScRNASeqTemplate,"Template for describing raw data from single-cell RNA-sequencing (scRNA-seq)",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,runType,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,ScRNA_Seq_Template,Class,Template,Template,Assay_Template,,, +ProcessedAlignedReadsTemplate,"Template for describing aligned reads output data (i.e. BAM)",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,averageInsertSize,averageReadLength,averageBaseQuality,pairsOnDifferentChr,readsDuplicatedPercent,readsMappedPercent,meanCoverage,proportionCoverage10x,proportionCoverage30x,readDepth,totalReads,workflow,genomicReference,comments",TRUE,Sage Bionetworks,template,,,,Processed_Aligned_Reads_Template,Class,Template,Template,Assay_Template,,, +ProcessedVariantCallsTemplate,"Template for describing either germline or variant calls output data (i.e. VCF/MAF)",,"Component,Filename,resourceType,progressReportNumber,specimenID,dataType,assay,individualID,workflow,comments",TRUE,Sage Bionetworks,template,,,,Processed_Variant_Calls_Template,Class,Template,Template,Assay_Template,,, +ProcessedExpressionTemplate,"Template for describing expression output data",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,individualID,specimenID,workflow,expressionUnit,comments",TRUE,Sage Bionetworks,template,,,,Processed_Expression_Template,Class,Template,Template,Assay_Template,,, +imagingAssayTemplate,"Generic template for describing data from an imaging type assay (IHC, etc). This is a one-step template.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,assay,platformTarget,individualID,parentSpecimenID,comments",TRUE,Sage Bionetworks,template,,,,Imaging_Assay_Template,Class,Template,Template,Assay_Template,,, +imagingAssayTemplate_Extended,"Template for describing data from an imaging type assay (IHC, etc) with extended properties for capturing additional metadata such as gene perturbation parameters or experimental conditions and time points. This is a one-step template.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,assay,platformTarget,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,genePerturbed,comments",TRUE,Sage Bionetworks,template,,,,Imaging_Assay_Template_Extended,Class,Template,Template,Assay_Template,,, +MRIAssayTemplate,Generic template for describing data from an MRI assay. This is a one-step template.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,MRISequence,comments",TRUE,Sage Bionetworks,template,,,,MRI_Assay_Template,Class,Template,Template,Assay_Template,,, +epigeneticsAssayTemplate,Generic template for describing data from an epigenetics assay. This is a one-step template.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,Epigenetics_Assay_Template,Class,Template,Template,Assay_Template,,, +pharmacokineticsAssayTemplate,Generic template for describing data from a pharmacokinetics assay. This is a one-step template.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,assay,platformTarget,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,genePerturbed,comments",TRUE,Sage Bionetworks,template,,,,Pharmacokinetics_Assay_Template,Class,Template,Template,Assay_Template,,, +proteomicsAssayTemplate,Generic template for describing data from a proteomics assay. Note that specialized proteomics assays may have their own template to capture more detailed information. This is a one-step template.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,proteinExtractSource,comments ",TRUE,Sage Bionetworks,template,,,,Proteomics_Assay_Template,Class,Template,Template,Assay_Template,,, +plateBasedReporterAssayTemplate,Generic template for describing data from a plate-based reporter assay. This is a one-step template.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,assay,platformTarget,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,reporterGene,reporterSubstance,comments",TRUE,Sage Bionetworks,template,,,,Plate_Based_Reporter_Assay_Template,Class,Template,Template,Assay_Template,,, +patientTimepointsTemplate,Template for capturing individual-level metadata with time points. Do not use for data file annotation.,,"Component,individualID,experimentalTimepoint",TRUE,Sage Bionetworks,template,,,,Patient_Timepoints_Template,Class,Template,Template,Non_Assay_Template,,, +clinicalAssayTemplate,"Annotation template for simple endpoint data from clinical assays often used in diagnostic practice or clinical trials; may include repeated measures and a treatment/intervention context. Examples include bloodwork results (creatine assay, serum antibody assay), tumor size measurements, or medication adherence. Note that clinical data are from human individuals, therefore species should be “human”. ",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,comments",TRUE,Sage Bionetworks,template,,,,Clinical_Assay_Template,Class,Template,Template,Assay_Template,,, +clinicalAssayTemplate_Extended,Annotation template for simple endpoint data from clinical assays often used in diagnostic practice or clinical trials; may include repeated measures and a treatment/intervention context. Extended to capture additional drug/treatment parameters.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,compoundName,compoundDose,comments",TRUE,Sage Bionetworks,template,,,,Clinical_Assay_Template_Extended,Class,Template,Template,Assay_Template,,, +behavioralAssayTemplate,"Generic template for describing data from behavioral assays such as “adaptive n-back task” (for humans) or “shock-probe defensive burying test” (for mice). If another modality is used as part of the behavioral assay, e.g. fMRI, that data can be linked.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,experimentalCondition,experimentalTimepoint,comments",TRUE,Sage Bionetworks,template,,,,Behavioral_Assay_Template,Class,Template,Template,Assay_Template,,, +sourceCodeTemplate,Template for describing scripts or source code files for a software application.,,"Component,Filename,resourceType,programmingLanguage,documentation,runtimePlatform,comments",TRUE,Sage Bionetworks,template,,,,Source_Code_Template,Class,Template,Template,Non_Assay_Template,,, +protocolTemplate,Template for describing a protocol document. (BETA) Adapted from https://bioschema.org/profiles/LabProtocol/0.6-DRAFT-2020_12_08,,"Component,Filename,resourceType,author,citation,license,comments",TRUE,Sage Bionetworks,template,,,,Protocol_Template,Class,Template,Template,Non_Assay_Template,,, +pdxGenomicsAssay,Template for describing PDX assay data that extends genomicsAssay.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,transplantationType,genePerturbed,runType,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,PDX_Genomics_Assay_Template,Class,Template,Template,Assay_Template,,, +updateMilestoneReport,Defines a metadata template for updating milestone report values in NF studies -- currently a supported feature for NTAP and GFF.,,"Component,Filename,resourceType,progressReportNumber",FALSE,Sage Bionetworks,template,,,,Update_Milestone_Report,Class,Template,Template,Non_Assay_Template,,, +template,Parent attribute for the manifest template attributes.,,,FALSE,Sage Bionetworks,template,,,,Template,Class,Template,Template,,,, +individualTemplate,Base template for minimal information describing individual-level data within the NF scope. Not called “patientTemplate_Default” because individuals can be a non-human organism.,"individualID,sex,age,ageUnit,species,diagnosis,nf1Genotype,nf2Genotype","Component,individualID,sex,age,ageUnit,species,diagnosis,nf1Genotype,nf2Genotype",FALSE,Sage Bionetworks,template,,,,Individual_Template,Class,Template,Template,Non_Assay_Template,,, +biospecimenTemplate_Normalized,Base template for describing biospecimen-level data.,"parentSpecimenID,specimenID,aliquotID,organ,tissue,isCellLine,isPrimaryCell,cellType,tumorType,specimenPreparationMethod,modelSystemName","Component,parentSpecimenID,specimenID,aliquotID,organ,tissue,isCellLine,isPrimaryCell,cellType,tumorType,specimenPreparationMethod,modelSystemName",FALSE,Sage Bionetworks,template,,,,Biospecimen_Template_Normalized,Class,Template,Template,Non_Assay_Template,,, +biospecimenTemplate,Denormalized template for describing biospecimen data that includes all individual-level data as well.,,"Component,individualID,parentSpecimenID",FALSE,Sage Bionetworks,template,,,,Biospecimen_Template,Class,Template,Template,Non_Assay_Template,,, +dataFileComponent,Template component for describing a data file resource that extends fileTemplate_Default with required properties dataType and dataSubtype.,"Filename,entityId,fileFormat,resourceType,dataType,dataSubtype","Filename,entityId,fileFormat,resourceType,dataType,dataSubtype",FALSE,Sage Bionetworks,template,,,,Data_File_Component,Class,Template,TemplateComponent,,,, +experimentComponent,Template component for describing core experimental parameters.,"experimentalCondition,experimentalTimepoint","experimentalCondition,experimentalTimepoint",FALSE,Sage Bionetworks,template,,,,Experiment_Component,Class,Template,TemplateComponent,,,, +genePerturbComponent,Template component for adding genetic perturbation metadata. This applies only to some assays and does not make sense with e.g. behavioral assays.,"genePerturbed,genePerturbationType,genePerturbationTechnology","genePerturbed,genePerturbationType,genePerturbationTechnology",FALSE,Sage Bionetworks,template,,,,Gene_Perturb_Component,Class,Template,TemplateComponent,,,, +fileComponent,Template component for describing some file on the NF-OSI Synapse platform.,"Filename,entityId,fileFormat,resourceType","Filename,entityId,fileFormat,resourceType",FALSE,Sage Bionetworks,template,,,,File_Component,Class,Template,TemplateComponent,,,, ngsComponent,Template component capturing Next Gen Sequencing/genomics attributes.,"runType,readPair,isStranded,readPairOrientation,readStrandOrigin,libraryPrep,libraryPreparationMethod,dissociationMethod,readLength,nucleicAcidSource","runType,readPair,isStranded,readPairOrientation,readStrandOrigin,libraryPrep,libraryPreparationMethod,dissociationMethod,readLength,nucleicAcidSource",FALSE,Sage Bionetworks,template,,,,NGS_Component,Class,Template,TemplateComponent,,,, \ No newline at end of file diff --git a/NF.jsonld b/NF.jsonld index 6d47077a..c00d9ecb 100644 --- a/NF.jsonld +++ b/NF.jsonld @@ -5762,6 +5762,23 @@ "sms:required": "sms:false", "sms:validationRules": [] }, + { + "@id": "bts:TargetCaptureKitID", + "@type": "rdfs:Class", + "rdfs:comment": "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.", + "rdfs:label": "TargetCaptureKitID", + "rdfs:subClassOf": [ + { + "@id": "bts:ExperimentalData" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "targetCaptureKitID", + "sms:required": "sms:true", + "sms:validationRules": [] + }, { "@id": "bts:LibraryID", "@type": "rdfs:Class", @@ -6231,13 +6248,13 @@ "@id": "http://schema.biothings.io" }, "sms:displayName": "readLength", - "sms:required": "sms:false", + "sms:required": "sms:true", "sms:validationRules": [] }, { "@id": "bts:ReadDepth", "@type": "rdfs:Class", - "rdfs:comment": "If available, coverage statistic as output from bedtools coverage or samtools stats.", + "rdfs:comment": "If available, the coverage statistic as output from bedtools coverage or samtools stats.", "rdfs:label": "ReadDepth", "rdfs:subClassOf": [ { @@ -6276,6 +6293,40 @@ "sms:required": "sms:false", "sms:validationRules": [] }, + { + "@id": "bts:TotalReads", + "@type": "rdfs:Class", + "rdfs:comment": "If available, the total number of reads collected from samtools.", + "rdfs:label": "TotalReads", + "rdfs:subClassOf": [ + { + "@id": "bts:Ngs" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "totalReads", + "sms:required": "sms:false", + "sms:validationRules": [] + }, + { + "@id": "bts:TargetDepth", + "@type": "rdfs:Class", + "rdfs:comment": "The targeted read depth prior to sequencing.", + "rdfs:label": "TargetDepth", + "rdfs:subClassOf": [ + { + "@id": "bts:Ngs" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "targetDepth", + "sms:required": "sms:false", + "sms:validationRules": [] + }, { "@id": "bts:Head", "@type": "rdfs:Class", @@ -12538,7 +12589,7 @@ { "@id": "bts:GenomicVariants", "@type": "rdfs:Class", - "rdfs:comment": "Genomic alterations, including single nucleotide polymorphisms, short indels and structural variants, in a genome sequence.", + "rdfs:comment": "Genomic alterations, including single nucleotide polymorphisms, short indels and structural variants. Use more specific term if possible, esp. if data is only of one specific subset.", "rdfs:label": "GenomicVariants", "rdfs:subClassOf": [ { @@ -12557,6 +12608,116 @@ ], "sms:validationRules": [] }, + { + "@id": "bts:AlignedReads", + "@type": "rdfs:Class", + "rdfs:comment": "Aligned reads output from alignment workflows", + "rdfs:label": "AlignedReads", + "rdfs:subClassOf": [ + { + "@id": "bts:DataType" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "AlignedReads", + "sms:required": "sms:false", + "sms:requiresDependency": [ + { + "@id": "bts:Assay" + } + ], + "sms:validationRules": [] + }, + { + "@id": "bts:SomaticVariants", + "@type": "rdfs:Class", + "rdfs:comment": "Specifically genomic variants data that includes somatic variants and excludes germline variants", + "rdfs:label": "SomaticVariants", + "rdfs:subClassOf": [ + { + "@id": "bts:DataType" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "SomaticVariants", + "sms:required": "sms:false", + "sms:requiresDependency": [ + { + "@id": "bts:Assay" + } + ], + "sms:validationRules": [] + }, + { + "@id": "bts:AnnotatedSomaticVariants", + "@type": "rdfs:Class", + "rdfs:comment": "Specifically genomic variants data that includes somatic variants with annotations added from some annotation workflow", + "rdfs:label": "AnnotatedSomaticVariants", + "rdfs:subClassOf": [ + { + "@id": "bts:DataType" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "AnnotatedSomaticVariants", + "sms:required": "sms:false", + "sms:requiresDependency": [ + { + "@id": "bts:Assay" + } + ], + "sms:validationRules": [] + }, + { + "@id": "bts:GermlineVariants", + "@type": "rdfs:Class", + "rdfs:comment": "Specifically genomic variants data that includes called germline variants", + "rdfs:label": "GermlineVariants", + "rdfs:subClassOf": [ + { + "@id": "bts:DataType" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "GermlineVariants", + "sms:required": "sms:false", + "sms:requiresDependency": [ + { + "@id": "bts:Assay" + } + ], + "sms:validationRules": [] + }, + { + "@id": "bts:StructuralVariants", + "@type": "rdfs:Class", + "rdfs:comment": "Specifically genomic variants data classified as structural variants, which may be derived from specialized variant calling workflows", + "rdfs:label": "StructuralVariants", + "rdfs:subClassOf": [ + { + "@id": "bts:DataType" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "StructuralVariants", + "sms:required": "sms:false", + "sms:requiresDependency": [ + { + "@id": "bts:Assay" + } + ], + "sms:validationRules": [] + }, { "@id": "bts:Behaviorprocess", "@type": "rdfs:Class", @@ -15061,7 +15222,7 @@ { "@id": "bts:DataType", "@type": "rdfs:Class", - "rdfs:comment": "A type of experimental, clinical, or other data. This typically refers to a high-level data type, that is paired with a specific assay. For example, a file of dataType of \"\"genomicVariants\"\" might have an assay value of \"\"whole genome sequencing\"\". ", + "rdfs:comment": "A type of experimental, clinical, or other data. This 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`.", "rdfs:label": "DataType", "rdfs:subClassOf": [ { @@ -15137,6 +15298,21 @@ }, { "@id": "bts:Maskimage" + }, + { + "@id": "bts:AlignedReads" + }, + { + "@id": "bts:SomaticVariants" + }, + { + "@id": "bts:AnnotatedSomaticVariants" + }, + { + "@id": "bts:StructuralVariants" + }, + { + "@id": "bts:GermlineVariants" } ], "sms:displayName": "dataType", @@ -15148,6 +15324,40 @@ ], "sms:validationRules": [] }, + { + "@id": "bts:ExpressionUnit", + "@type": "rdfs:Class", + "rdfs:comment": "Measure used for transcript expression quantification", + "rdfs:label": "ExpressionUnit", + "rdfs:subClassOf": [ + { + "@id": "bts:ExperimentalData" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "schema:rangeIncludes": [ + { + "@id": "bts:TPM" + }, + { + "@id": "bts:RPKM" + }, + { + "@id": "bts:FPKM" + }, + { + "@id": "bts:Counts" + }, + { + "@id": "bts:Other" + } + ], + "sms:displayName": "expressionUnit", + "sms:required": "sms:true", + "sms:validationRules": [] + }, { "@id": "bts:FailedQC", "@type": "rdfs:Class", @@ -16545,10 +16755,10 @@ "sms:validationRules": [] }, { - "@id": "bts:Component", + "@id": "bts:Workflow", "@type": "rdfs:Class", - "rdfs:comment": "Category of metadata manifest; provide the same one for all items/rows.", - "rdfs:label": "Component", + "rdfs:comment": "Name and version of the workflow used to generate/analyze the data", + "rdfs:label": "Workflow", "rdfs:subClassOf": [ { "@id": "schema:Thing" @@ -16557,86 +16767,527 @@ "schema:isPartOf": { "@id": "http://schema.biothings.io" }, - "sms:displayName": "Component", - "sms:required": "sms:true", + "sms:displayName": "workflow", + "sms:required": "sms:false", + "sms:requiresDependency": [ + { + "@id": "bts:WorkflowLink" + } + ], "sms:validationRules": [] }, { - "@id": "bts:GenomicsAssayTemplateNormalized", + "@id": "bts:WorkflowLink", "@type": "rdfs:Class", - "rdfs:comment": "Generic template for describing data from a genomic type assay (RNA-seq, Exome-seq, etc) WITHOUT full individual and biospecimen data. To link individual and biospecimen metadata, an additional “biospecimenTemplate_Default” must be additionally completed with either specimenID or aliquotID available for joining. This is a two-step template.", - "rdfs:label": "GenomicsAssayTemplateNormalized", + "rdfs:comment": "Workflow URL reference", + "rdfs:label": "WorkflowLink", "rdfs:subClassOf": [ { - "@id": "bts:Template" + "@id": "schema:Thing" } ], "schema:isPartOf": { "@id": "http://schema.biothings.io" }, - "sms:displayName": "genomicsAssayTemplate_Normalized", - "sms:required": "sms:true", - "sms:requiresDependency": [ - { - "@id": "bts:Component" - }, - { - "@id": "bts:Filename" - }, - { - "@id": "bts:ResourceType" - }, - { - "@id": "bts:ProgressReportNumber" - }, - { - "@id": "bts:DataType" - }, - { - "@id": "bts:Assay" - }, - { - "@id": "bts:Platform" - }, - { - "@id": "bts:SpecimenID" - }, - { - "@id": "bts:AliquotID" - }, - { - "@id": "bts:RunType" - }, - { - "@id": "bts:LibraryPrep" - }, + "sms:displayName": "workflowLink", + "sms:required": "sms:false", + "sms:validationRules": [] + }, + { + "@id": "bts:GenomicReference", + "@type": "rdfs:Class", + "rdfs:comment": "Version of genome reference used for alignment in processing workflow", + "rdfs:label": "GenomicReference", + "rdfs:subClassOf": [ { - "@id": "bts:Comments" + "@id": "schema:Thing" } ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "genomicReference", + "sms:required": "sms:false", "sms:validationRules": [] }, { - "@id": "bts:GenomicsAssayTemplate", + "@id": "bts:AverageInsertSize", "@type": "rdfs:Class", - "rdfs:comment": "Generic denormalized template for describing data from a genomic type assay (RNA-seq, Exome-seq, etc) along with individual, biospecimen and experimental metadata. This is a one-step template.", - "rdfs:label": "GenomicsAssayTemplate", + "rdfs:comment": "Average insert size as reported by samtools", + "rdfs:label": "AverageInsertSize", "rdfs:subClassOf": [ { - "@id": "bts:Template" + "@id": "schema:Thing" } ], "schema:isPartOf": { "@id": "http://schema.biothings.io" }, - "sms:displayName": "genomicsAssayTemplate", - "sms:required": "sms:true", - "sms:requiresDependency": [ + "sms:displayName": "averageInsertSize", + "sms:required": "sms:false", + "sms:validationRules": [] + }, + { + "@id": "bts:AverageReadLength", + "@type": "rdfs:Class", + "rdfs:comment": "Average read length collected from samtools", + "rdfs:label": "AverageReadLength", + "rdfs:subClassOf": [ { - "@id": "bts:Component" - }, + "@id": "schema:Thing" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "averageReadLength", + "sms:required": "sms:false", + "sms:validationRules": [] + }, + { + "@id": "bts:AverageBaseQuality", + "@type": "rdfs:Class", + "rdfs:comment": "Average base quality collected from samtools", + "rdfs:label": "AverageBaseQuality", + "rdfs:subClassOf": [ { - "@id": "bts:Filename" + "@id": "schema:Thing" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "averageBaseQuality", + "sms:required": "sms:false", + "sms:validationRules": [] + }, + { + "@id": "bts:PairsOnDifferentChr", + "@type": "rdfs:Class", + "rdfs:comment": "Pairs on different chromosomes collected from samtools", + "rdfs:label": "PairsOnDifferentChr", + "rdfs:subClassOf": [ + { + "@id": "schema:Thing" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "pairsOnDifferentChr", + "sms:required": "sms:false", + "sms:validationRules": [] + }, + { + "@id": "bts:ReadsDuplicatedPercent", + "@type": "rdfs:Class", + "rdfs:comment": "Percent of duplicated reads collected from samtools", + "rdfs:label": "ReadsDuplicatedPercent", + "rdfs:subClassOf": [ + { + "@id": "schema:Thing" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "readsDuplicatedPercent", + "sms:required": "sms:false", + "sms:validationRules": [] + }, + { + "@id": "bts:ReadsMappedPercent", + "@type": "rdfs:Class", + "rdfs:comment": "Percent of mapped reads collected from samtools", + "rdfs:label": "ReadsMappedPercent", + "rdfs:subClassOf": [ + { + "@id": "schema:Thing" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "readsMappedPercent", + "sms:required": "sms:false", + "sms:validationRules": [] + }, + { + "@id": "bts:MeanCoverage", + "@type": "rdfs:Class", + "rdfs:comment": "Mean coverage for whole genome sequencing, or mean target coverage for whole exome and targeted sequencing, collected from Picard Tools", + "rdfs:label": "MeanCoverage", + "rdfs:subClassOf": [ + { + "@id": "schema:Thing" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "meanCoverage", + "sms:required": "sms:false", + "sms:validationRules": [] + }, + { + "@id": "bts:ProportionCoverage10x", + "@type": "rdfs:Class", + "rdfs:comment": "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", + "rdfs:label": "ProportionCoverage10x", + "rdfs:subClassOf": [ + { + "@id": "schema:Thing" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "proportionCoverage10x", + "sms:required": "sms:false", + "sms:validationRules": [] + }, + { + "@id": "bts:ProportionCoverage30x", + "@type": "rdfs:Class", + "rdfs:comment": "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", + "rdfs:label": "ProportionCoverage30x", + "rdfs:subClassOf": [ + { + "@id": "schema:Thing" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "proportionCoverage30x", + "sms:required": "sms:false", + "sms:validationRules": [] + }, + { + "@id": "bts:Component", + "@type": "rdfs:Class", + "rdfs:comment": "Category of metadata manifest; provide the same one for all items/rows.", + "rdfs:label": "Component", + "rdfs:subClassOf": [ + { + "@id": "schema:Thing" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "Component", + "sms:required": "sms:true", + "sms:validationRules": [] + }, + { + "@id": "bts:GenomicsAssayTemplateNormalized", + "@type": "rdfs:Class", + "rdfs:comment": "Generic template for describing raw data from a genomic type assay (RNA-seq, Exome-seq, etc) WITHOUT full individual and biospecimen data. To link individual and biospecimen metadata, an additional “biospecimenTemplate_Default” must be additionally completed with either specimenID or aliquotID available for joining. This is a two-step template.", + "rdfs:label": "GenomicsAssayTemplateNormalized", + "rdfs:subClassOf": [ + { + "@id": "bts:Template" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "genomicsAssayTemplate_Normalized", + "sms:required": "sms:true", + "sms:requiresDependency": [ + { + "@id": "bts:Component" + }, + { + "@id": "bts:Filename" + }, + { + "@id": "bts:ResourceType" + }, + { + "@id": "bts:ProgressReportNumber" + }, + { + "@id": "bts:DataType" + }, + { + "@id": "bts:Assay" + }, + { + "@id": "bts:Platform" + }, + { + "@id": "bts:SpecimenID" + }, + { + "@id": "bts:AliquotID" + }, + { + "@id": "bts:RunType" + }, + { + "@id": "bts:LibraryPrep" + }, + { + "@id": "bts:Comments" + } + ], + "sms:validationRules": [] + }, + { + "@id": "bts:GenomicsAssayTemplate", + "@type": "rdfs:Class", + "rdfs:comment": "Generic denormalized template for describing raw data from a genomic type assay (RNA-seq, Exome-seq, etc) along with individual, biospecimen and experimental metadata. This is a one-step template.", + "rdfs:label": "GenomicsAssayTemplate", + "rdfs:subClassOf": [ + { + "@id": "bts:Template" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "genomicsAssayTemplate", + "sms:required": "sms:true", + "sms:requiresDependency": [ + { + "@id": "bts:Component" + }, + { + "@id": "bts:Filename" + }, + { + "@id": "bts:ResourceType" + }, + { + "@id": "bts:ProgressReportNumber" + }, + { + "@id": "bts:DataType" + }, + { + "@id": "bts:Assay" + }, + { + "@id": "bts:Platform" + }, + { + "@id": "bts:IndividualID" + }, + { + "@id": "bts:ParentSpecimenID" + }, + { + "@id": "bts:RunType" + }, + { + "@id": "bts:LibraryPrep" + }, + { + "@id": "bts:Comments" + } + ], + "sms:validationRules": [] + }, + { + "@id": "bts:GenomicsAssayTemplateExtended", + "@type": "rdfs:Class", + "rdfs:comment": "Template for describing raw data from a genomic type assay (RNA-seq, Exome-seq, etc) with extended properties for capturing additional metadata such as gene perturbation parameters or experimental conditions and time points. This is a one-step template.", + "rdfs:label": "GenomicsAssayTemplateExtended", + "rdfs:subClassOf": [ + { + "@id": "bts:Template" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "genomicsAssayTemplate_Extended", + "sms:required": "sms:true", + "sms:requiresDependency": [ + { + "@id": "bts:Component" + }, + { + "@id": "bts:Filename" + }, + { + "@id": "bts:ResourceType" + }, + { + "@id": "bts:ProgressReportNumber" + }, + { + "@id": "bts:DataType" + }, + { + "@id": "bts:Assay" + }, + { + "@id": "bts:Platform" + }, + { + "@id": "bts:IndividualID" + }, + { + "@id": "bts:ParentSpecimenID" + }, + { + "@id": "bts:ExperimentalCondition" + }, + { + "@id": "bts:ExperimentalTimepoint" + }, + { + "@id": "bts:RunType" + }, + { + "@id": "bts:LibraryPrep" + }, + { + "@id": "bts:GenePerturbed" + }, + { + "@id": "bts:Comments" + } + ], + "sms:validationRules": [] + }, + { + "@id": "bts:WGSTemplate", + "@type": "rdfs:Class", + "rdfs:comment": "Template for describing raw data from Whole Genome Sequencing (WGS)", + "rdfs:label": "WGSTemplate", + "rdfs:subClassOf": [ + { + "@id": "bts:Template" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "WGSTemplate", + "sms:required": "sms:true", + "sms:requiresDependency": [ + { + "@id": "bts:Component" + }, + { + "@id": "bts:Filename" + }, + { + "@id": "bts:ResourceType" + }, + { + "@id": "bts:ProgressReportNumber" + }, + { + "@id": "bts:DataType" + }, + { + "@id": "bts:Assay" + }, + { + "@id": "bts:Platform" + }, + { + "@id": "bts:IndividualID" + }, + { + "@id": "bts:ParentSpecimenID" + }, + { + "@id": "bts:RunType" + }, + { + "@id": "bts:LibraryPrep" + }, + { + "@id": "bts:Comments" + } + ], + "sms:validationRules": [] + }, + { + "@id": "bts:WESTemplate", + "@type": "rdfs:Class", + "rdfs:comment": "Template for describing raw data from Whole Exome Sequencing (WES)", + "rdfs:label": "WESTemplate", + "rdfs:subClassOf": [ + { + "@id": "bts:Template" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "WESTemplate", + "sms:required": "sms:true", + "sms:requiresDependency": [ + { + "@id": "bts:Component" + }, + { + "@id": "bts:Filename" + }, + { + "@id": "bts:ResourceType" + }, + { + "@id": "bts:ProgressReportNumber" + }, + { + "@id": "bts:DataType" + }, + { + "@id": "bts:Assay" + }, + { + "@id": "bts:Platform" + }, + { + "@id": "bts:IndividualID" + }, + { + "@id": "bts:ParentSpecimenID" + }, + { + "@id": "bts:RunType" + }, + { + "@id": "bts:TargetCaptureKitID" + }, + { + "@id": "bts:LibraryPrep" + }, + { + "@id": "bts:Comments" + } + ], + "sms:validationRules": [] + }, + { + "@id": "bts:RNASeqTemplate", + "@type": "rdfs:Class", + "rdfs:comment": "Template for describing raw data from (bulk) RNA-sequencing", + "rdfs:label": "RNASeqTemplate", + "rdfs:subClassOf": [ + { + "@id": "bts:Template" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "RNASeqTemplate", + "sms:required": "sms:true", + "sms:requiresDependency": [ + { + "@id": "bts:Component" + }, + { + "@id": "bts:Filename" }, { "@id": "bts:ResourceType" @@ -16665,6 +17316,9 @@ { "@id": "bts:LibraryPrep" }, + { + "@id": "bts:TargetDepth" + }, { "@id": "bts:Comments" } @@ -16672,10 +17326,10 @@ "sms:validationRules": [] }, { - "@id": "bts:GenomicsAssayTemplateExtended", + "@id": "bts:ScRNASeqTemplate", "@type": "rdfs:Class", - "rdfs:comment": "Template for describing data from a genomic type assay (RNA-seq, Exome-seq, etc) with extended properties for capturing additional metadata such as gene perturbation parameters or experimental conditions and time points. This is a one-step template.", - "rdfs:label": "GenomicsAssayTemplateExtended", + "rdfs:comment": "Template for describing raw data from single-cell RNA-sequencing (scRNA-seq)", + "rdfs:label": "ScRNASeqTemplate", "rdfs:subClassOf": [ { "@id": "bts:Template" @@ -16684,7 +17338,7 @@ "schema:isPartOf": { "@id": "http://schema.biothings.io" }, - "sms:displayName": "genomicsAssayTemplate_Extended", + "sms:displayName": "ScRNASeqTemplate", "sms:required": "sms:true", "sms:requiresDependency": [ { @@ -16715,19 +17369,199 @@ "@id": "bts:ParentSpecimenID" }, { - "@id": "bts:ExperimentalCondition" + "@id": "bts:RunType" }, { - "@id": "bts:ExperimentalTimepoint" + "@id": "bts:LibraryPrep" }, { - "@id": "bts:RunType" + "@id": "bts:Comments" + } + ], + "sms:validationRules": [] + }, + { + "@id": "bts:ProcessedAlignedReadsTemplate", + "@type": "rdfs:Class", + "rdfs:comment": "Template for describing aligned reads output data (i.e. BAM)", + "rdfs:label": "ProcessedAlignedReadsTemplate", + "rdfs:subClassOf": [ + { + "@id": "bts:Template" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "ProcessedAlignedReadsTemplate", + "sms:required": "sms:true", + "sms:requiresDependency": [ + { + "@id": "bts:Component" }, { - "@id": "bts:LibraryPrep" + "@id": "bts:Filename" }, { - "@id": "bts:GenePerturbed" + "@id": "bts:ResourceType" + }, + { + "@id": "bts:ProgressReportNumber" + }, + { + "@id": "bts:DataType" + }, + { + "@id": "bts:Assay" + }, + { + "@id": "bts:Platform" + }, + { + "@id": "bts:IndividualID" + }, + { + "@id": "bts:ParentSpecimenID" + }, + { + "@id": "bts:AverageInsertSize" + }, + { + "@id": "bts:AverageReadLength" + }, + { + "@id": "bts:AverageBaseQuality" + }, + { + "@id": "bts:PairsOnDifferentChr" + }, + { + "@id": "bts:ReadsDuplicatedPercent" + }, + { + "@id": "bts:ReadsMappedPercent" + }, + { + "@id": "bts:MeanCoverage" + }, + { + "@id": "bts:ProportionCoverage10x" + }, + { + "@id": "bts:ProportionCoverage30x" + }, + { + "@id": "bts:ReadDepth" + }, + { + "@id": "bts:TotalReads" + }, + { + "@id": "bts:Workflow" + }, + { + "@id": "bts:GenomicReference" + }, + { + "@id": "bts:Comments" + } + ], + "sms:validationRules": [] + }, + { + "@id": "bts:ProcessedVariantCallsTemplate", + "@type": "rdfs:Class", + "rdfs:comment": "Template for describing either germline or variant calls output data (i.e. VCF/MAF)", + "rdfs:label": "ProcessedVariantCallsTemplate", + "rdfs:subClassOf": [ + { + "@id": "bts:Template" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "ProcessedVariantCallsTemplate", + "sms:required": "sms:true", + "sms:requiresDependency": [ + { + "@id": "bts:Component" + }, + { + "@id": "bts:Filename" + }, + { + "@id": "bts:ResourceType" + }, + { + "@id": "bts:ProgressReportNumber" + }, + { + "@id": "bts:SpecimenID" + }, + { + "@id": "bts:DataType" + }, + { + "@id": "bts:Assay" + }, + { + "@id": "bts:IndividualID" + }, + { + "@id": "bts:Workflow" + }, + { + "@id": "bts:Comments" + } + ], + "sms:validationRules": [] + }, + { + "@id": "bts:ProcessedExpressionTemplate", + "@type": "rdfs:Class", + "rdfs:comment": "Template for describing expression output data", + "rdfs:label": "ProcessedExpressionTemplate", + "rdfs:subClassOf": [ + { + "@id": "bts:Template" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "ProcessedExpressionTemplate", + "sms:required": "sms:true", + "sms:requiresDependency": [ + { + "@id": "bts:Component" + }, + { + "@id": "bts:Filename" + }, + { + "@id": "bts:ResourceType" + }, + { + "@id": "bts:ProgressReportNumber" + }, + { + "@id": "bts:DataType" + }, + { + "@id": "bts:Assay" + }, + { + "@id": "bts:IndividualID" + }, + { + "@id": "bts:SpecimenID" + }, + { + "@id": "bts:Workflow" + }, + { + "@id": "bts:ExpressionUnit" }, { "@id": "bts:Comments" @@ -16793,7 +17627,7 @@ { "@id": "bts:ImagingAssayTemplateExtended", "@type": "rdfs:Class", - "rdfs:comment": "Template for describing data from an imaging type assay (IHC, etc) with extended properties for capturing additional metadata such as gene perturbation parameters or experimental conditions and time points.. This is a one-step template.", + "rdfs:comment": "Template for describing data from an imaging type assay (IHC, etc) with extended properties for capturing additional metadata such as gene perturbation parameters or experimental conditions and time points. This is a one-step template.", "rdfs:label": "ImagingAssayTemplateExtended", "rdfs:subClassOf": [ { @@ -18352,6 +19186,91 @@ "sms:required": "sms:false", "sms:validationRules": [] }, + { + "@id": "bts:TPM", + "@type": "rdfs:Class", + "rdfs:comment": "TBD", + "rdfs:label": "TPM", + "rdfs:subClassOf": [ + { + "@id": "bts:ExpressionUnit" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "TPM", + "sms:required": "sms:false", + "sms:validationRules": [] + }, + { + "@id": "bts:RPKM", + "@type": "rdfs:Class", + "rdfs:comment": "TBD", + "rdfs:label": "RPKM", + "rdfs:subClassOf": [ + { + "@id": "bts:ExpressionUnit" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "RPKM", + "sms:required": "sms:false", + "sms:validationRules": [] + }, + { + "@id": "bts:FPKM", + "@type": "rdfs:Class", + "rdfs:comment": "TBD", + "rdfs:label": "FPKM", + "rdfs:subClassOf": [ + { + "@id": "bts:ExpressionUnit" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "FPKM", + "sms:required": "sms:false", + "sms:validationRules": [] + }, + { + "@id": "bts:Counts", + "@type": "rdfs:Class", + "rdfs:comment": "TBD", + "rdfs:label": "Counts", + "rdfs:subClassOf": [ + { + "@id": "bts:ExpressionUnit" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "Counts", + "sms:required": "sms:false", + "sms:validationRules": [] + }, + { + "@id": "bts:Other", + "@type": "rdfs:Class", + "rdfs:comment": "TBD", + "rdfs:label": "Other", + "rdfs:subClassOf": [ + { + "@id": "bts:ExpressionUnit" + } + ], + "schema:isPartOf": { + "@id": "http://schema.biothings.io" + }, + "sms:displayName": "Other", + "sms:required": "sms:false", + "sms:validationRules": [] + }, { "@id": "bts:EntityId", "@type": "rdfs:Class", diff --git a/docs/docTemplate.R b/docs/docTemplate.R index 38cd40dd..a85bddef 100644 --- a/docs/docTemplate.R +++ b/docs/docTemplate.R @@ -1,39 +1,62 @@ -#' Function to generate template documentation +#' Generate template documentation #' -#' Creates one row per property and selected informational columns for: -#' - marginality (required vs. recommended vs. optional; in our case, recommended/optional collapsed to optional) -#' - controlled values / constraints on fields -#' - cardinality (one or many values allowed) *currently omitted, see additional notes -#' Example related resources for what this can look like: -#' 1. https://bioschemas.org/profiles/ComputationalWorkflow/1.0-RELEASE -#' 2. https://fairplus.github.io/the-fair-cookbook/content/recipes/interoperability/transcriptomics-metadata.html#assay-metadata -#' 3. https://www.immport.org/shared/templateDocumentation?tab=1&template=bioSamples.txt -#' 4. https://lincsproject.org/LINCS/files//2020_exp_meta_stand/General_Proteomics.pdf -#' Marginality is mentioned in all examples. -#' CV is mentioned for #1,2,3. -#' Cardinality is mentioned in #1 only, so it's not prioritized. -docTemplate <- function(schema, savedir = "templates/") { - templates <- schema %>% - filter(Root == "Template" & SubOf != "") %>% - select(ID, DependsOn) - for(template in templates$ID) { - fields <- schema %>% - filter(template == ID) %>% - pull(DependsOn) %>% - strsplit(split = ", ?") %>% - unlist() - index <- match(fields, schema$Attribute) - # ControlledVocab col is handled specially and is derived from the Range col - # Range is either filled with a class or blank, where blank means free text or Boolean values - # Bools are "controlled vocabulary" vs. true ontology terms - range <- dplyr::if_else(schema[index, "Range"] != "", paste0("#", schema[index, "Range"]), schema[index, "Valid.Values"]) - template_tab <- data.frame(Field = fields, - Description = schema[index, "Description"], - Required = ifelse(schema[index, "Required"], "required", "optional"), - ControlledVocab = range, - # Cardinality = schema[index, "Cardinality"], - Note = schema[index, "EditorNote"]) - write.csv(template_tab, file = paste0(savedir, template, ".csv"), row.names = F) +#' Basically tries to present a template in a conventional format similar to: +#' 1. [GDC viewer](https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads) +#' 2. [Bioschema profile](https://bioschemas.org/profiles/ComputationalWorkflow/1.0-RELEASE) +#' 3. [FAIRplus example](https://fairplus.github.io/the-fair-cookbook/content/recipes/interoperability/transcriptomics-metadata.html#assay-metadata) +#' 4. [Immport template doc](https://www.immport.org/shared/templateDocumentation?tab=1&template=bioSamples.txt) +#' 5. [LINCS template doc](https://lincsproject.org/LINCS/files//2020_exp_meta_stand/General_Proteomics.pdf) +#' +#' In general it looks like a table with one row per property and informational columns for: +#' - [x] controlled values (valid values for schematic) / range of property +#' - [ ] marginality (required vs. recommended vs. optional) +#' - [ ] cardinality (one or many values allowed) +#' - [x] notes / comments +#' +#' Currently, schematic templates allow modeling more on the simplistic side and +#' don't formally express all these, so only a few are checked. +#' Moreover, the jsonld version encodes much less information than the csv version +#' (jsonld conversion loses custom metadata in the csv), which is why this currently depends on both formats. +#' +#' @param templates Named vector of templates to process, +#' where names corresponds to id without prefix (currently whatever follows "bts:"), +#' and value is the real internal ID (in .ID). +#' @param schema_csv Schema representation read from `.csv`. +#' @param schema_jsonld Schema path to jsonld file. +#' @param savedir Directory where template representations will be outputted. +docTemplate <- function(templates, + schema_csv, + schema_jsonld = "../NF.jsonld", + savedir = "templates/") { + + + for(x in names(templates)) { # e.g. x <- "GenomicsAssayTemplate" + # For template, parse DependsOn to get all props present in manifest + props <- nfportalutils::get_dependency_from_json_schema(paste0("bts:", x), + schema = schema_jsonld) + + # Create the ControlledVocab aka Range col for each prop + # ControlledVocab col is handled specially and uses a custom Range col defined in csv + # For CV col we create a link to a class if the term editor has referenced a class in Range, + # else we simply fall back to enumerating the valid values + index <- match(props, schema_csv$Attribute) + range <- dplyr::if_else(schema_csv[index, "Range"] != "", + paste0("#", schema_csv[index, "Range"]), + schema_csv[index, "Valid.Values"]) + + template_tab <- data.table(Field = props, + Description = schema_csv[index, "Description"], + Required = ifelse(schema_csv[index, "Required"], "required", "optional"), + ControlledVocab = range, + # Cardinality = schema_csv[index, "Cardinality"], + Note = schema_csv[index, "EditorNote"]) + + # Sort to show by required, then alphabetically + template_tab <- template_tab[order(-Required, Field), ] + + template_id <- templates[x] + filepath <- paste0(savedir, template_id, ".csv") + write.csv(template_tab, file = filepath, row.names = F) } } diff --git a/docs/index.Rmd b/docs/index.Rmd index a1efdc07..2200237c 100644 --- a/docs/index.Rmd +++ b/docs/index.Rmd @@ -14,10 +14,12 @@ params: schema_csv: "../NF.csv" ext_classes_csv: "../ext_classes.csv" ext_relations_csv: "../ext_relations.csv" + use_cache: false --- ```{r setup, include=FALSE} knitr::opts_chunk$set(echo = TRUE) +library(data.table) library(tidyverse) library(reactable) library(htmltools) @@ -100,8 +102,38 @@ schema <- read.csv(params$schema_csv) %>% # docTemplate needs the unmodified schema table -docTemplate(schema) - +if(!params$use_cache) { + docTemplate(templates = c(# genomics/transcriptomics + GenomicsAssayTemplate = "Genomics_Assay_Template", + WGSTemplate = "WGS_Template", + WESTemplate = "WES_Template", + EpigeneticsAssayTemplate = "Epigenetics_Assay_Template", + RNASeqTemplate = "RNASeq_Template", + ScRNASeqTemplate = "ScRNASeq_Template", + + # genomics/transcriptomics -- processed + ProcessedAlignedReadsTemplate = "Processed_Aligned_Reads_Template", + ProcessedVariantCallsTemplate = "Processed_Variant_Calls_Template", + ProcessedExpressionTemplate = "Processed_Expression_Template", + + # proteomics + ProteomicsAssayTemplate = "Proteomics_Assay_Template", + + # imaging + ImagingAssayTemplate = "Imaging_Assay_Template", + MRIAssayTemplate = "MRI_Assay_Template", + + # other + PharmacokineticsAssayTemplate = "Pharmacokinetics_Assay_Template", # drug assays type + PlateBasedReporterAssayTemplate = "Plate_Based_Reporter_Assay_Template", + ClinicalAssayTemplate = "Clinical_Assay_Template", + PatientTimepointsTemplate = "Patient_Timepoints_Template", + SourceCodeTemplate = "Source_Code_Template" + ), + schema_csv = schema + ) +} + # Splits terms into Property or Class using `Type` # schema_class <- schema %>% # filter(Type == "Class") @@ -278,6 +310,19 @@ This partial graph view logically relates **data types** to **assays**. *Documentation currently in development.* +#### Data Level {#Data .tabset .tabset-fade .tabset-pills} + +##### Terms + +```{r data_subtypes_table, echo=FALSE} + +data_level_table <- schema %>% + filter(Parent == "dataSubtype") %>% + select(Attribute, Description, DependsOn) + +basicTable(data_level_table) +``` + #### File Format {#File_Format .tabset .tabset-fade .tabset-pills} ##### Terms @@ -492,17 +537,18 @@ This includes modules that are shared. :::info Annotation templates are spreadsheet templates that allow contributors to annotate resources uploaded to the repository. -They are generated at the [NF Data Curator App](https://shiny.synapse.org/users/rallaway/NF_data_curator/). -Templates aim to implement "minimum metadata" standards specific to the type of data/resource. +See interactive use of these templates at our [NF Data Curator App](https://shiny.synapse.org/users/rallaway/NF_data_curator/). +Templates implement "minimum metadata" standards specific to the type of data/resource (hence variants exist for assay types and "raw" vs "processed" data). +Templates also contain common components, e.g. many will collect core sample info associated with the data. Unless the template field is free-text, it is meant to be filled by the contributor using the ontology terms/controlled vocabulary defined here. For example, the "assay" property allows the contributor to use [terms under Assay](#assay). ::: -#### Templates for Assay Data {#Assay_Template .tabset .tabset-fade .tabset-pills} +#### Genomics Assay Templates {#Genomics_Assay_Templates .tabset .tabset-fade .tabset-pills} ```{r standard_properties_table, echo=FALSE, eval=FALSE} -# NOT RUN +# CURRENTLY NOT RUN (eval=FALSE) # Custom code to get unique set of properties used across all templates standard_properties_table <- schema %>% filter(Parent %in% c("template")) %>% @@ -511,7 +557,7 @@ standard_properties_table <- schema %>% basicTable(standard_properties_table) ``` -##### Genomics Assay +##### Genomics Assay (Generic) ```{r echo=FALSE } @@ -519,21 +565,84 @@ templateTable(read.csv("templates/Genomics_Assay_Template.csv")) ``` -##### Proteomics Assay +##### Epigenetics Assay ```{r echo=FALSE } -templateTable(read.csv("templates/Proteomics_Assay_Template.csv")) +templateTable(read.csv("templates/Epigenetics_Assay_Template.csv")) ``` -##### Epigenetics Assay + +##### WES Assay + ```{r echo=FALSE } -templateTable(read.csv("templates/Epigenetics_Assay_Template.csv")) +templateTable(read.csv("templates/WES_Template.csv")) + +``` + +##### WGS Assay + +```{r echo=FALSE } + +templateTable(read.csv("templates/WGS_Template.csv")) + +``` + +##### Bulk RNA-Seq Assay + +```{r echo=FALSE } + +templateTable(read.csv("templates/RNASeq_Template.csv")) ``` -##### Imaging Assay +##### Single-cell RNA-Seq Assay + +```{r echo=FALSE } + +templateTable(read.csv("templates/ScRNASeq_Template.csv")) + +``` + + +##### Processed Aligned Reads + +```{r echo=FALSE } + +templateTable(read.csv("templates/Processed_Aligned_Reads_Template.csv")) + +``` + +##### Processed Variant Calls + +```{r echo=FALSE } + +templateTable(read.csv("templates/Processed_Variant_Calls_Template.csv")) + +``` + +##### Processed Expression + +```{r echo=FALSE } + +templateTable(read.csv("templates/Processed_Expression_Template.csv")) + +``` + +#### Proteomics Assay Templates {#Proteomics_Assay_Templates .tabset .tabset-fade .tabset-pills} + +##### Proteomics Assay (Generic) +```{r echo=FALSE } + +templateTable(read.csv("templates/Proteomics_Assay_Template.csv")) + +``` + + +#### Imaging Assay Templates {#Imaging_Assay_Templates .tabset .tabset-fade .tabset-pills} + +##### Imaging Assay (Generic) ```{r echo=FALSE } templateTable(read.csv("templates/Imaging_Assay_Template.csv")) @@ -547,6 +656,7 @@ templateTable(read.csv("templates/MRI_Assay_Template.csv")) ``` +#### Other Assay Templates {#Other_Assay_Templates .tabset .tabset-fade .tabset-pills} ##### Pharmacokinetics Assay @@ -563,14 +673,16 @@ templateTable(read.csv("templates/Plate_Based_Reporter_Assay_Template.csv")) ``` -##### Clinical Assay +#### Clinical Assay Templates {#Clinical_Assay_Templates .tabset .tabset-fade .tabset-pills} + +##### Clinical Assay (Generic) ```{r echo=FALSE } templateTable(read.csv("templates/Clinical_Assay_Template.csv")) ``` -#### Other Templates {#Non_Assay_Template .tabset .tabset-fade .tabset-pills} +#### Non-Assay Templates {#Non_Assay_Template .tabset .tabset-fade .tabset-pills} ##### Patient Timepoints ```{r echo=FALSE } diff --git a/docs/index.html b/docs/index.html index cd6a7f73..0fab1091 100644 --- a/docs/index.html +++ b/docs/index.html @@ -70,8 +70,7 @@ - - + @@ -96,9 +95,6 @@ summary { display: list-item; } -details > summary > p:only-child { - display: inline; -} pre code { padding: 0; } @@ -262,7 +258,7 @@

NF Vocabulary / Schema

NF-OSI DCC

-

Last updated on 2022-06-06

+

Last updated on 2022-06-19

@@ -278,24 +274,24 @@

Assay Module

Assay

Terms
-
- +
+
Relations Graph

This partial graph view logically relates assays to metadata templates available at the NF Data Curator App. For example, assays under the classification of Imaging_Assay currently uses a generic Imaging_Assay_Template for annotation. More specialized templates may be made available as needed for specific assays.

-
- +
+

Platform

Terms
-
- +
+
Relations Graph
@@ -314,28 +310,28 @@

Parameters

NGS Parameter
Library Prep
-
- +
+
Library Prep Method
-
- +
+
Read Pair
-
- +
+
Read Pair Orientation
-
- +
+
Run Type
-
- +
+
@@ -346,8 +342,8 @@

Data Module

Data Type

Terms
-
- +
+
Relations Graph
@@ -357,9 +353,17 @@
Relations Graph

Documentation currently in development.

+
+

Data Level

+
+
Terms
+
+ +
+

File Format

-
+
Terms
Certain formats are emphasized as @@ -372,8 +376,8 @@
Terms

(open) formats.

-
- +
+
Relations Graph
@@ -392,34 +396,34 @@

Biosample Module

Sex

-
+
Terms
-
- +
+

Species

-
+
Terms
-
- +
+

Diagnosis

-
+
Terms
-
- +
+

Genotype

-
+
Terms
-
- +
+

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.

@@ -428,23 +432,23 @@
Terms

Sample Site

-
+
Terms
-
- +
+

Sample Specimen

Tissue
-
- +
+
Cell / Cell Line
-
- +
+
@@ -457,10 +461,10 @@

Specimen State

Tumor Class

-
+
Terms
-
- +
+
@@ -470,13 +474,13 @@

Experiment Module

Gene Perturbation

Gene Perturbation Type
-
- +
+
Gene Perturbation Technology
-
- +
+
@@ -494,62 +498,110 @@

Model System

Annotation Templates

-

Annotation templates are spreadsheet templates that allow contributors to annotate resources uploaded to the repository. They are generated at the NF Data Curator App. Templates aim to implement “minimum metadata” standards specific to the type of data/resource. Unless the template field is free-text, it is meant to be filled by the contributor using the ontology terms/controlled vocabulary defined here. For example, the “assay” property allows the contributor to use terms under Assay.

-
-
-

Templates for Assay Data

-
-
Genomics Assay
-
- +

Annotation templates are spreadsheet templates that allow contributors to annotate resources uploaded to the repository. See interactive use of these templates at our NF Data Curator App. Templates implement “minimum metadata” standards specific to the type of data/resource (hence variants exist for assay types and “raw” vs “processed” data). Templates also contain common components, e.g. many will collect core sample info associated with the data.
+Unless the template field is free-text, it is meant to be filled by the contributor using the ontology terms/controlled vocabulary defined here. For example, the “assay” property allows the contributor to use terms under Assay.

-
-
Proteomics Assay
-
- +
+

Genomics Assay Templates

+
+
Genomics Assay (Generic)
+
+
Epigenetics Assay
-
- -
-
-
Imaging Assay
-
- +
+ +
+
+
WES Assay
+
+ +
+
+
WGS Assay
+
+ +
+
+
Bulk RNA-Seq Assay
+
+ +
+
+
Single-cell RNA-Seq Assay
+
+ +
+
+
Processed Aligned Reads
+
+ +
+
+
Processed Variant Calls
+
+ +
+
+
Processed Expression
+
+ +
+
+
+

Proteomics Assay Templates

+
+
Proteomics Assay (Generic)
+
+ +
+
+
+

Imaging Assay Templates

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

Other Assay Templates

Pharmacokinetics Assay
-
- +
+
Plate Based Reporter Assay
-
- +
+ +
-
-
Clinical Assay
-
- +
+

Clinical Assay Templates

+
+
Clinical Assay (Generic)
+
+
-

Other Templates

+

Non-Assay Templates

Patient Timepoints
-
- +
+
Source Code
-
- +
+
@@ -560,10 +612,10 @@

Reserved Properties

Reserved annotation properties also describe the resource in some way, but they are not expected to be edited directly by contributors. They are computed/automated annotations set by the data platform and DCC activities.

-
+
Terms
-
- +
+
diff --git a/docs/templates/Behavioral_Assay_Template.csv b/docs/templates/Behavioral_Assay_Template.csv deleted file mode 100644 index 257067d4..00000000 --- a/docs/templates/Behavioral_Assay_Template.csv +++ /dev/null @@ -1,12 +0,0 @@ -"Field","Description","Required","ControlledVocab","Note" -"Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" -"Filename","The name of the file.","required","","Automatically filled when using the curator app." -"resourceType","The type of resource being stored and annotated","required","#Resource","" -"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" -"dataType","A type of experimental, clinical, or other data. This typically refers to a high-level data type, that is paired with a specific assay. For example, a file of dataType of """"genomicVariants"""" might have an assay value of """"whole genome sequencing"""". ","required","#Data","" -"assay","The technology used to generate the data in this file","required","#Assay","" -"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" -"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." -"experimentalCondition","A free-text description of the experimental condition (e.g. 5 mM doxorubicin).","optional","","" -"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","optional","","" -"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" diff --git a/docs/templates/Biospecimen_Template.csv b/docs/templates/Biospecimen_Template.csv deleted file mode 100644 index 8bc1c162..00000000 --- a/docs/templates/Biospecimen_Template.csv +++ /dev/null @@ -1,4 +0,0 @@ -"Field","Description","Required","ControlledVocab","Note" -"Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" -"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." -"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" diff --git a/docs/templates/Biospecimen_Template_Normalized.csv b/docs/templates/Biospecimen_Template_Normalized.csv deleted file mode 100644 index 1a1a4053..00000000 --- a/docs/templates/Biospecimen_Template_Normalized.csv +++ /dev/null @@ -1,13 +0,0 @@ -"Field","Description","Required","ControlledVocab","Note" -"Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" -"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" -"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. This can be the A A unique identifier (non-PII) that represents the","optional","","Typically annotated with a single ID, but many allowed for summary data." -"aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID. ","optional","","" -"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.","optional","#Organ","" -"tissue","A tissue is a mereologically maximal collection of cells that together perform physiological function.","optional","#Tissue","" -"isCellLine","Whether or not sample source is a cell line (Yes; No)","optional","Yes, No","" -"isPrimaryCell","Whether or not cellType is primary (Yes; No)","optional","Yes, No","" -"cellType","A cell type is a distinct morphological or functional form of cell.","optional","#Cell","" -"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","optional","#Tumor","" -"specimenPreparationMethod","Term that represents preservation of the sample before usage in, e.g. sequencing","optional","#Specimen_State","" -"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): HEK293T (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","optional","#Model_System","" diff --git a/docs/templates/Clinical_Assay_Template.csv b/docs/templates/Clinical_Assay_Template.csv index ddb3fb49..bd06bf84 100644 --- a/docs/templates/Clinical_Assay_Template.csv +++ b/docs/templates/Clinical_Assay_Template.csv @@ -1,13 +1,34 @@ "Field","Description","Required","ControlledVocab","Note" "Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" "Filename","The name of the file.","required","","Automatically filled when using the curator app." -"resourceType","The type of resource being stored and annotated","required","#Resource","" -"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" -"dataType","A type of experimental, clinical, or other data. This typically refers to a high-level data type, that is paired with a specific assay. For example, a file of dataType of """"genomicVariants"""" might have an assay value of """"whole genome sequencing"""". ","required","#Data","" "assay","The technology used to generate the data in this file","required","#Assay","" -"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" -"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." -"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" +"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.","required","#Data_Level","" +"dataType","A type of experimental, clinical, or other data. This 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`.","required","#Data","" +"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","required","#File_Format","" +"resourceType","The type of resource being stored and annotated","required","#Resource","" +"age","A numeric value representing age of the individual. Use with ageUnit.","optional","","" +"ageUnit","A time unit that can be used with a given age value, e.g. years.","optional","days, months, years","" +"aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID. ","optional","","" +"cellType","A cell type is a distinct morphological or functional form of cell.","optional","#Cell","" +"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","optional","#Diagnosis","Currently a single NF diagnosis allowed; in the future multiple diagnoses may be allowed for comorbidities." "experimentalCondition","A free-text description of the experimental condition (e.g. 5 mM doxorubicin).","optional","","" "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","optional","","" -"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." +"isCellLine","Whether or not sample source is a cell line (Yes; No)","optional","Yes, No","" +"isPrimaryCell","Whether or not cellType is primary (Yes; No)","optional","Yes, No","" +"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): HEK293T (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","optional","#Model_System","" +"nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"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.","optional","#Organ","" +"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" +"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" +"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" +"sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","optional","#Sex","" +"species","The name of a species (typically a taxonomic group) of organism.","optional","#Species","" +"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. This can be the A A unique identifier (non-PII) that represents the","optional","","Typically annotated with a single ID, but many allowed for summary data." +"specimenPreparationMethod","Term that represents preservation of the sample before usage in, e.g. sequencing","optional","#Specimen_State","" +"timePointUnit","For timed experiments this represents the unit of time measured","optional","#Time_Unit","" +"tissue","A tissue is a mereologically maximal collection of cells that together perform physiological function.","optional","#Tissue","" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","optional","#Tumor","" +"entityId",NA,NA,NA,NA diff --git a/docs/templates/Clinical_Assay_Template_Extended.csv b/docs/templates/Clinical_Assay_Template_Extended.csv deleted file mode 100644 index b465b9bb..00000000 --- a/docs/templates/Clinical_Assay_Template_Extended.csv +++ /dev/null @@ -1,15 +0,0 @@ -"Field","Description","Required","ControlledVocab","Note" -"Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" -"Filename","The name of the file.","required","","Automatically filled when using the curator app." -"resourceType","The type of resource being stored and annotated","required","#Resource","" -"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" -"dataType","A type of experimental, clinical, or other data. This typically refers to a high-level data type, that is paired with a specific assay. For example, a file of dataType of """"genomicVariants"""" might have an assay value of """"whole genome sequencing"""". ","required","#Data","" -"assay","The technology used to generate the data in this file","required","#Assay","" -"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" -"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." -"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" -"experimentalCondition","A free-text description of the experimental condition (e.g. 5 mM doxorubicin).","optional","","" -"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","optional","","" -"compoundName","Common name for a compound, e.g. “Selumetinib” (https://pubchem.ncbi.nlm.nih.gov/compound/10127622)","optional","","" -"compoundDose","A dose quantity for the treatment compound. To be used with compoundDoseUnit.","optional","","" -"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" diff --git a/docs/templates/Epigenetics_Assay_Template.csv b/docs/templates/Epigenetics_Assay_Template.csv index f2ac5400..60d2a36f 100644 --- a/docs/templates/Epigenetics_Assay_Template.csv +++ b/docs/templates/Epigenetics_Assay_Template.csv @@ -1,14 +1,38 @@ "Field","Description","Required","ControlledVocab","Note" "Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" "Filename","The name of the file.","required","","Automatically filled when using the curator app." -"resourceType","The type of resource being stored and annotated","required","#Resource","" -"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" -"dataType","A type of experimental, clinical, or other data. This typically refers to a high-level data type, that is paired with a specific assay. For example, a file of dataType of """"genomicVariants"""" might have an assay value of """"whole genome sequencing"""". ","required","#Data","" "assay","The technology used to generate the data in this file","required","#Assay","" -"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" -"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." -"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" +"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.","required","#Data_Level","" +"dataType","A type of experimental, clinical, or other data. This 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`.","required","#Data","" +"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","required","#File_Format","" +"resourceType","The type of resource being stored and annotated","required","#Resource","" +"age","A numeric value representing age of the individual. Use with ageUnit.","optional","","" +"ageUnit","A time unit that can be used with a given age value, e.g. years.","optional","days, months, years","" +"aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID. ","optional","","" +"cellType","A cell type is a distinct morphological or functional form of cell.","optional","#Cell","" +"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","optional","#Diagnosis","Currently a single NF diagnosis allowed; in the future multiple diagnoses may be allowed for comorbidities." +"dissociationMethod","Procedure by which a biological specimen is dissociated into individual cells or a cell suspension","optional","#Dissociation_Method","" "experimentalCondition","A free-text description of the experimental condition (e.g. 5 mM doxorubicin).","optional","","" "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","optional","","" +"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." +"isCellLine","Whether or not sample source is a cell line (Yes; No)","optional","Yes, No","" +"isPrimaryCell","Whether or not cellType is primary (Yes; No)","optional","Yes, No","" "libraryPrep","The general strategy by which the library was prepared","optional","#Library_Prep","" -"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"libraryPreparationMethod","Method by which library was prepared","optional","#Library_Preparation_Method","" +"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): HEK293T (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","optional","#Model_System","" +"nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nucleicAcidSource","Source of the extracted nucleic acid used in the experiment","optional","#Nucleic_Acid_Source","" +"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.","optional","#Organ","" +"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" +"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" +"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" +"sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","optional","#Sex","" +"species","The name of a species (typically a taxonomic group) of organism.","optional","#Species","" +"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. This can be the A A unique identifier (non-PII) that represents the","optional","","Typically annotated with a single ID, but many allowed for summary data." +"specimenPreparationMethod","Term that represents preservation of the sample before usage in, e.g. sequencing","optional","#Specimen_State","" +"timePointUnit","For timed experiments this represents the unit of time measured","optional","#Time_Unit","" +"tissue","A tissue is a mereologically maximal collection of cells that together perform physiological function.","optional","#Tissue","" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","optional","#Tumor","" +"entityId",NA,NA,NA,NA diff --git a/docs/templates/Genomics_Assay_Template.csv b/docs/templates/Genomics_Assay_Template.csv index 30a3d8b4..bc0bb804 100644 --- a/docs/templates/Genomics_Assay_Template.csv +++ b/docs/templates/Genomics_Assay_Template.csv @@ -1,13 +1,42 @@ "Field","Description","Required","ControlledVocab","Note" "Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" "Filename","The name of the file.","required","","Automatically filled when using the curator app." -"resourceType","The type of resource being stored and annotated","required","#Resource","" -"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" -"dataType","A type of experimental, clinical, or other data. This typically refers to a high-level data type, that is paired with a specific assay. For example, a file of dataType of """"genomicVariants"""" might have an assay value of """"whole genome sequencing"""". ","required","#Data","" "assay","The technology used to generate the data in this file","required","#Assay","" -"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" +"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.","required","#Data_Level","" +"dataType","A type of experimental, clinical, or other data. This 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`.","required","#Data","" +"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","required","#File_Format","" +"readLength","Number of base pairs (bp) sequenced for a read","required","","" +"resourceType","The type of resource being stored and annotated","required","#Resource","" +"age","A numeric value representing age of the individual. Use with ageUnit.","optional","","" +"ageUnit","A time unit that can be used with a given age value, e.g. years.","optional","days, months, years","" +"aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID. ","optional","","" +"cellType","A cell type is a distinct morphological or functional form of cell.","optional","#Cell","" +"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","optional","#Diagnosis","Currently a single NF diagnosis allowed; in the future multiple diagnoses may be allowed for comorbidities." +"dissociationMethod","Procedure by which a biological specimen is dissociated into individual cells or a cell suspension","optional","#Dissociation_Method","" "individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." +"isCellLine","Whether or not sample source is a cell line (Yes; No)","optional","Yes, No","" +"isPrimaryCell","Whether or not cellType is primary (Yes; No)","optional","Yes, No","" +"isStranded","Whether or not the library is stranded (Yes; No)","optional","Yes, No","" +"libraryPrep","The general strategy by which the library was prepared","optional","#Library_Prep","" +"libraryPreparationMethod","Method by which library was prepared","optional","#Library_Preparation_Method","" +"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): HEK293T (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","optional","#Model_System","" +"nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nucleicAcidSource","Source of the extracted nucleic acid used in the experiment","optional","#Nucleic_Acid_Source","" +"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.","optional","#Organ","" "parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" +"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" +"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" +"readDepth","If available, the coverage statistic as output from bedtools coverage or samtools stats.","optional","","" +"readPair","The read of origin","optional","#Read_Pair","" +"readPairOrientation","The relative orientation of the reads in a paired-end protocol","optional","#Read_Pair_Orientation","" +"readStrandOrigin","The strand from which the read originates in a strand-specific protocol","optional","#Read_Strand_Origin","" "runType","Is the sequencing run single or paired end?","optional","#Run_Type","" -"libraryPrep","The general strategy by which the library was prepared","optional","#Library_Prep","" -"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","optional","#Sex","" +"species","The name of a species (typically a taxonomic group) of organism.","optional","#Species","" +"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. This can be the A A unique identifier (non-PII) that represents the","optional","","Typically annotated with a single ID, but many allowed for summary data." +"specimenPreparationMethod","Term that represents preservation of the sample before usage in, e.g. sequencing","optional","#Specimen_State","" +"tissue","A tissue is a mereologically maximal collection of cells that together perform physiological function.","optional","#Tissue","" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","optional","#Tumor","" +"entityId",NA,NA,NA,NA diff --git a/docs/templates/Genomics_Assay_Template_Extended.csv b/docs/templates/Genomics_Assay_Template_Extended.csv deleted file mode 100644 index 26f47d82..00000000 --- a/docs/templates/Genomics_Assay_Template_Extended.csv +++ /dev/null @@ -1,16 +0,0 @@ -"Field","Description","Required","ControlledVocab","Note" -"Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" -"Filename","The name of the file.","required","","Automatically filled when using the curator app." -"resourceType","The type of resource being stored and annotated","required","#Resource","" -"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" -"dataType","A type of experimental, clinical, or other data. This typically refers to a high-level data type, that is paired with a specific assay. For example, a file of dataType of """"genomicVariants"""" might have an assay value of """"whole genome sequencing"""". ","required","#Data","" -"assay","The technology used to generate the data in this file","required","#Assay","" -"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" -"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." -"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" -"experimentalCondition","A free-text description of the experimental condition (e.g. 5 mM doxorubicin).","optional","","" -"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","optional","","" -"runType","Is the sequencing run single or paired end?","optional","#Run_Type","" -"libraryPrep","The general strategy by which the library was prepared","optional","#Library_Prep","" -"genePerturbed","The HUGO gene symbol for the gene that is perturbed.","optional","","" -"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" diff --git a/docs/templates/Genomics_Assay_Template_Normalized.csv b/docs/templates/Genomics_Assay_Template_Normalized.csv deleted file mode 100644 index 4522eef4..00000000 --- a/docs/templates/Genomics_Assay_Template_Normalized.csv +++ /dev/null @@ -1,13 +0,0 @@ -"Field","Description","Required","ControlledVocab","Note" -"Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" -"Filename","The name of the file.","required","","Automatically filled when using the curator app." -"resourceType","The type of resource being stored and annotated","required","#Resource","" -"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" -"dataType","A type of experimental, clinical, or other data. This typically refers to a high-level data type, that is paired with a specific assay. For example, a file of dataType of """"genomicVariants"""" might have an assay value of """"whole genome sequencing"""". ","required","#Data","" -"assay","The technology used to generate the data in this file","required","#Assay","" -"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" -"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. This can be the A A unique identifier (non-PII) that represents the","optional","","Typically annotated with a single ID, but many allowed for summary data." -"aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID. ","optional","","" -"runType","Is the sequencing run single or paired end?","optional","#Run_Type","" -"libraryPrep","The general strategy by which the library was prepared","optional","#Library_Prep","" -"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" diff --git a/docs/templates/Imaging_Assay_Template.csv b/docs/templates/Imaging_Assay_Template.csv index c784c248..287db22a 100644 --- a/docs/templates/Imaging_Assay_Template.csv +++ b/docs/templates/Imaging_Assay_Template.csv @@ -1,13 +1,32 @@ "Field","Description","Required","ControlledVocab","Note" "Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" "Filename","The name of the file.","required","","Automatically filled when using the curator app." -"resourceType","The type of resource being stored and annotated","required","#Resource","" -"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" -"dataType","A type of experimental, clinical, or other data. This typically refers to a high-level data type, that is paired with a specific assay. For example, a file of dataType of """"genomicVariants"""" might have an assay value of """"whole genome sequencing"""". ","required","#Data","" -"assay","The technology used to generate the data in this file","required","#Assay","" -"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" "assay","The technology used to generate the data in this file","required","#Assay","" -"platformTarget",NA,NA,NA,NA +"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.","required","#Data_Level","" +"dataType","A type of experimental, clinical, or other data. This 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`.","required","#Data","" +"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","required","#File_Format","" +"resourceType","The type of resource being stored and annotated","required","#Resource","" +"age","A numeric value representing age of the individual. Use with ageUnit.","optional","","" +"ageUnit","A time unit that can be used with a given age value, e.g. years.","optional","days, months, years","" +"aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID. ","optional","","" +"cellType","A cell type is a distinct morphological or functional form of cell.","optional","#Cell","" +"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","optional","#Diagnosis","Currently a single NF diagnosis allowed; in the future multiple diagnoses may be allowed for comorbidities." "individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." +"isCellLine","Whether or not sample source is a cell line (Yes; No)","optional","Yes, No","" +"isPrimaryCell","Whether or not cellType is primary (Yes; No)","optional","Yes, No","" +"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): HEK293T (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","optional","#Model_System","" +"nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"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.","optional","#Organ","" "parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" -"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" +"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" +"sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","optional","#Sex","" +"species","The name of a species (typically a taxonomic group) of organism.","optional","#Species","" +"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. This can be the A A unique identifier (non-PII) that represents the","optional","","Typically annotated with a single ID, but many allowed for summary data." +"specimenPreparationMethod","Term that represents preservation of the sample before usage in, e.g. sequencing","optional","#Specimen_State","" +"tissue","A tissue is a mereologically maximal collection of cells that together perform physiological function.","optional","#Tissue","" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","optional","#Tumor","" +"entityId",NA,NA,NA,NA +"platformTarget",NA,NA,NA,NA diff --git a/docs/templates/Imaging_Assay_Template_Extended.csv b/docs/templates/Imaging_Assay_Template_Extended.csv deleted file mode 100644 index 9946b1ce..00000000 --- a/docs/templates/Imaging_Assay_Template_Extended.csv +++ /dev/null @@ -1,16 +0,0 @@ -"Field","Description","Required","ControlledVocab","Note" -"Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" -"Filename","The name of the file.","required","","Automatically filled when using the curator app." -"resourceType","The type of resource being stored and annotated","required","#Resource","" -"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" -"dataType","A type of experimental, clinical, or other data. This typically refers to a high-level data type, that is paired with a specific assay. For example, a file of dataType of """"genomicVariants"""" might have an assay value of """"whole genome sequencing"""". ","required","#Data","" -"assay","The technology used to generate the data in this file","required","#Assay","" -"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" -"assay","The technology used to generate the data in this file","required","#Assay","" -"platformTarget",NA,NA,NA,NA -"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." -"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" -"experimentalCondition","A free-text description of the experimental condition (e.g. 5 mM doxorubicin).","optional","","" -"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","optional","","" -"genePerturbed","The HUGO gene symbol for the gene that is perturbed.","optional","","" -"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" diff --git a/docs/templates/Individual_Template.csv b/docs/templates/Individual_Template.csv deleted file mode 100644 index af4c5dfb..00000000 --- a/docs/templates/Individual_Template.csv +++ /dev/null @@ -1,10 +0,0 @@ -"Field","Description","Required","ControlledVocab","Note" -"Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" -"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." -"sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","optional","#Sex","" -"age","A numeric value representing age of the individual. Use with ageUnit.","optional","","" -"ageUnit","A time unit that can be used with a given age value, e.g. years.","optional","days, months, years","" -"species","The name of a species (typically a taxonomic group) of organism.","optional","#Species","" -"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","optional","#Diagnosis","Currently a single NF diagnosis allowed; in the future multiple diagnoses may be allowed for comorbidities." -"nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" -"nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" diff --git a/docs/templates/MRI_Assay_Template.csv b/docs/templates/MRI_Assay_Template.csv index c60e0933..e5f38f78 100644 --- a/docs/templates/MRI_Assay_Template.csv +++ b/docs/templates/MRI_Assay_Template.csv @@ -1,14 +1,35 @@ "Field","Description","Required","ControlledVocab","Note" "Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" "Filename","The name of the file.","required","","Automatically filled when using the curator app." -"resourceType","The type of resource being stored and annotated","required","#Resource","" -"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" -"dataType","A type of experimental, clinical, or other data. This typically refers to a high-level data type, that is paired with a specific assay. For example, a file of dataType of """"genomicVariants"""" might have an assay value of """"whole genome sequencing"""". ","required","#Data","" "assay","The technology used to generate the data in this file","required","#Assay","" -"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" -"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." -"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" -"experimentalCondition","A free-text description of the experimental condition (e.g. 5 mM doxorubicin).","optional","","" -"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","optional","","" +"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.","required","#Data_Level","" +"dataType","A type of experimental, clinical, or other data. This 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`.","required","#Data","" +"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","required","#File_Format","" +"resourceType","The type of resource being stored and annotated","required","#Resource","" "MRISequence","The scanning sequence/modality that is used for a conventional MRI scan.","optional","T1-weighted,T2-weighted,PD-weighted,Short Tau Inversion Recovery","" +"age","A numeric value representing age of the individual. Use with ageUnit.","optional","","" +"ageUnit","A time unit that can be used with a given age value, e.g. years.","optional","days, months, years","" +"aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID. ","optional","","" +"cellType","A cell type is a distinct morphological or functional form of cell.","optional","#Cell","" "comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","optional","#Diagnosis","Currently a single NF diagnosis allowed; in the future multiple diagnoses may be allowed for comorbidities." +"experimentalCondition","A free-text description of the experimental condition (e.g. 5 mM doxorubicin).","optional","","" +"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","optional","","" +"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." +"isCellLine","Whether or not sample source is a cell line (Yes; No)","optional","Yes, No","" +"isPrimaryCell","Whether or not cellType is primary (Yes; No)","optional","Yes, No","" +"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): HEK293T (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","optional","#Model_System","" +"nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"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.","optional","#Organ","" +"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" +"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" +"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" +"sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","optional","#Sex","" +"species","The name of a species (typically a taxonomic group) of organism.","optional","#Species","" +"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. This can be the A A unique identifier (non-PII) that represents the","optional","","Typically annotated with a single ID, but many allowed for summary data." +"specimenPreparationMethod","Term that represents preservation of the sample before usage in, e.g. sequencing","optional","#Specimen_State","" +"timePointUnit","For timed experiments this represents the unit of time measured","optional","#Time_Unit","" +"tissue","A tissue is a mereologically maximal collection of cells that together perform physiological function.","optional","#Tissue","" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","optional","#Tumor","" +"entityId",NA,NA,NA,NA diff --git a/docs/templates/PDX_Genomics_Assay_Template.csv b/docs/templates/PDX_Genomics_Assay_Template.csv deleted file mode 100644 index 773ca237..00000000 --- a/docs/templates/PDX_Genomics_Assay_Template.csv +++ /dev/null @@ -1,17 +0,0 @@ -"Field","Description","Required","ControlledVocab","Note" -"Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" -"Filename","The name of the file.","required","","Automatically filled when using the curator app." -"resourceType","The type of resource being stored and annotated","required","#Resource","" -"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" -"dataType","A type of experimental, clinical, or other data. This typically refers to a high-level data type, that is paired with a specific assay. For example, a file of dataType of """"genomicVariants"""" might have an assay value of """"whole genome sequencing"""". ","required","#Data","" -"assay","The technology used to generate the data in this file","required","#Assay","" -"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" -"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." -"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" -"experimentalCondition","A free-text description of the experimental condition (e.g. 5 mM doxorubicin).","optional","","" -"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","optional","","" -"transplantationType","Type of transplantation involved in the experiment, derived from MESH","optional","allograft, xenograft, autograft, isograft","" -"genePerturbed","The HUGO gene symbol for the gene that is perturbed.","optional","","" -"runType","Is the sequencing run single or paired end?","optional","#Run_Type","" -"libraryPrep","The general strategy by which the library was prepared","optional","#Library_Prep","" -"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" diff --git a/docs/templates/Patient_Timepoints_Template.csv b/docs/templates/Patient_Timepoints_Template.csv index 58744d5b..336a6605 100644 --- a/docs/templates/Patient_Timepoints_Template.csv +++ b/docs/templates/Patient_Timepoints_Template.csv @@ -1,4 +1,12 @@ "Field","Description","Required","ControlledVocab","Note" "Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" -"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." +"age","A numeric value representing age of the individual. Use with ageUnit.","optional","","" +"ageUnit","A time unit that can be used with a given age value, e.g. years.","optional","days, months, years","" +"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","optional","#Diagnosis","Currently a single NF diagnosis allowed; in the future multiple diagnoses may be allowed for comorbidities." "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","optional","","" +"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." +"nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","optional","#Sex","" +"species","The name of a species (typically a taxonomic group) of organism.","optional","#Species","" +"timePointUnit","For timed experiments this represents the unit of time measured","optional","#Time_Unit","" diff --git a/docs/templates/Pharmacokinetics_Assay_Template.csv b/docs/templates/Pharmacokinetics_Assay_Template.csv index 9946b1ce..6088e0a8 100644 --- a/docs/templates/Pharmacokinetics_Assay_Template.csv +++ b/docs/templates/Pharmacokinetics_Assay_Template.csv @@ -1,16 +1,38 @@ "Field","Description","Required","ControlledVocab","Note" "Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" "Filename","The name of the file.","required","","Automatically filled when using the curator app." -"resourceType","The type of resource being stored and annotated","required","#Resource","" -"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" -"dataType","A type of experimental, clinical, or other data. This typically refers to a high-level data type, that is paired with a specific assay. For example, a file of dataType of """"genomicVariants"""" might have an assay value of """"whole genome sequencing"""". ","required","#Data","" -"assay","The technology used to generate the data in this file","required","#Assay","" -"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" "assay","The technology used to generate the data in this file","required","#Assay","" -"platformTarget",NA,NA,NA,NA -"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." -"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" +"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.","required","#Data_Level","" +"dataType","A type of experimental, clinical, or other data. This 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`.","required","#Data","" +"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","required","#File_Format","" +"resourceType","The type of resource being stored and annotated","required","#Resource","" +"age","A numeric value representing age of the individual. Use with ageUnit.","optional","","" +"ageUnit","A time unit that can be used with a given age value, e.g. years.","optional","days, months, years","" +"aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID. ","optional","","" +"cellType","A cell type is a distinct morphological or functional form of cell.","optional","#Cell","" +"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","optional","#Diagnosis","Currently a single NF diagnosis allowed; in the future multiple diagnoses may be allowed for comorbidities." "experimentalCondition","A free-text description of the experimental condition (e.g. 5 mM doxorubicin).","optional","","" "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","optional","","" +"genePerturbationTechnology","Technology used to perform gene perturbation","optional","#Gene_Perturbation_Technology","" +"genePerturbationType","Specific way in which a single gene was perturbed in a sample","optional","#Gene_Perturbation","" "genePerturbed","The HUGO gene symbol for the gene that is perturbed.","optional","","" -"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." +"isCellLine","Whether or not sample source is a cell line (Yes; No)","optional","Yes, No","" +"isPrimaryCell","Whether or not cellType is primary (Yes; No)","optional","Yes, No","" +"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): HEK293T (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","optional","#Model_System","" +"nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"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.","optional","#Organ","" +"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" +"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" +"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" +"sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","optional","#Sex","" +"species","The name of a species (typically a taxonomic group) of organism.","optional","#Species","" +"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. This can be the A A unique identifier (non-PII) that represents the","optional","","Typically annotated with a single ID, but many allowed for summary data." +"specimenPreparationMethod","Term that represents preservation of the sample before usage in, e.g. sequencing","optional","#Specimen_State","" +"timePointUnit","For timed experiments this represents the unit of time measured","optional","#Time_Unit","" +"tissue","A tissue is a mereologically maximal collection of cells that together perform physiological function.","optional","#Tissue","" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","optional","#Tumor","" +"entityId",NA,NA,NA,NA +"platformTarget",NA,NA,NA,NA diff --git a/docs/templates/Plate_Based_Reporter_Assay_Template.csv b/docs/templates/Plate_Based_Reporter_Assay_Template.csv index ba435e78..89940165 100644 --- a/docs/templates/Plate_Based_Reporter_Assay_Template.csv +++ b/docs/templates/Plate_Based_Reporter_Assay_Template.csv @@ -1,17 +1,37 @@ "Field","Description","Required","ControlledVocab","Note" "Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" "Filename","The name of the file.","required","","Automatically filled when using the curator app." -"resourceType","The type of resource being stored and annotated","required","#Resource","" -"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" -"dataType","A type of experimental, clinical, or other data. This typically refers to a high-level data type, that is paired with a specific assay. For example, a file of dataType of """"genomicVariants"""" might have an assay value of """"whole genome sequencing"""". ","required","#Data","" -"assay","The technology used to generate the data in this file","required","#Assay","" -"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" "assay","The technology used to generate the data in this file","required","#Assay","" -"platformTarget",NA,NA,NA,NA -"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." -"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" +"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.","required","#Data_Level","" +"dataType","A type of experimental, clinical, or other data. This 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`.","required","#Data","" +"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","required","#File_Format","" +"resourceType","The type of resource being stored and annotated","required","#Resource","" +"age","A numeric value representing age of the individual. Use with ageUnit.","optional","","" +"ageUnit","A time unit that can be used with a given age value, e.g. years.","optional","days, months, years","" +"aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID. ","optional","","" +"cellType","A cell type is a distinct morphological or functional form of cell.","optional","#Cell","" +"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","optional","#Diagnosis","Currently a single NF diagnosis allowed; in the future multiple diagnoses may be allowed for comorbidities." "experimentalCondition","A free-text description of the experimental condition (e.g. 5 mM doxorubicin).","optional","","" "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","optional","","" +"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." +"isCellLine","Whether or not sample source is a cell line (Yes; No)","optional","Yes, No","" +"isPrimaryCell","Whether or not cellType is primary (Yes; No)","optional","Yes, No","" +"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): HEK293T (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","optional","#Model_System","" +"nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"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.","optional","#Organ","" +"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" +"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" +"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" "reporterGene","A biological material (clone, oligo, etc.) on an array which will report on some biosequence or biosequences.","optional","","" "reporterSubstance","A gene which produces an easily assayed phenotype. Often used for expression studies of heterologous promoters.","optional","","" -"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","optional","#Sex","" +"species","The name of a species (typically a taxonomic group) of organism.","optional","#Species","" +"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. This can be the A A unique identifier (non-PII) that represents the","optional","","Typically annotated with a single ID, but many allowed for summary data." +"specimenPreparationMethod","Term that represents preservation of the sample before usage in, e.g. sequencing","optional","#Specimen_State","" +"timePointUnit","For timed experiments this represents the unit of time measured","optional","#Time_Unit","" +"tissue","A tissue is a mereologically maximal collection of cells that together perform physiological function.","optional","#Tissue","" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","optional","#Tumor","" +"entityId",NA,NA,NA,NA +"platformTarget",NA,NA,NA,NA diff --git a/docs/templates/Processed_Aligned_Reads_Template.csv b/docs/templates/Processed_Aligned_Reads_Template.csv new file mode 100644 index 00000000..e7f38918 --- /dev/null +++ b/docs/templates/Processed_Aligned_Reads_Template.csv @@ -0,0 +1,45 @@ +"Field","Description","Required","ControlledVocab","Note" +"Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" +"Filename","The name of the file.","required","","Automatically filled when using the curator app." +"assay","The technology used to generate the data in this file","required","#Assay","" +"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.","required","#Data_Level","" +"dataType","A type of experimental, clinical, or other data. This 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`.","required","#Data","" +"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","required","#File_Format","" +"resourceType","The type of resource being stored and annotated","required","#Resource","" +"age","A numeric value representing age of the individual. Use with ageUnit.","optional","","" +"ageUnit","A time unit that can be used with a given age value, e.g. years.","optional","days, months, years","" +"aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID. ","optional","","" +"averageBaseQuality","Average base quality collected from samtools","optional","","" +"averageInsertSize","Average insert size as reported by samtools","optional","","" +"averageReadLength","Average read length collected from samtools","optional","","" +"cellType","A cell type is a distinct morphological or functional form of cell.","optional","#Cell","" +"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","optional","#Diagnosis","Currently a single NF diagnosis allowed; in the future multiple diagnoses may be allowed for comorbidities." +"genomicReference","Version of genome reference used for alignment in processing workflow","optional","","" +"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." +"isCellLine","Whether or not sample source is a cell line (Yes; No)","optional","Yes, No","" +"isPrimaryCell","Whether or not cellType is primary (Yes; No)","optional","Yes, No","" +"meanCoverage","Mean coverage for whole genome sequencing, or mean target coverage for whole exome and targeted sequencing, collected from Picard Tools","optional","","" +"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): HEK293T (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","optional","#Model_System","" +"nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"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.","optional","#Organ","" +"pairsOnDifferentChr","Pairs on different chromosomes collected from samtools","optional","","" +"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" +"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" +"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" +"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","optional","","" +"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","optional","","" +"readDepth","If available, the coverage statistic as output from bedtools coverage or samtools stats.","optional","","" +"readsDuplicatedPercent","Percent of duplicated reads collected from samtools","optional","","" +"readsMappedPercent","Percent of mapped reads collected from samtools","optional","","" +"sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","optional","#Sex","" +"species","The name of a species (typically a taxonomic group) of organism.","optional","#Species","" +"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. This can be the A A unique identifier (non-PII) that represents the","optional","","Typically annotated with a single ID, but many allowed for summary data." +"specimenPreparationMethod","Term that represents preservation of the sample before usage in, e.g. sequencing","optional","#Specimen_State","" +"tissue","A tissue is a mereologically maximal collection of cells that together perform physiological function.","optional","#Tissue","" +"totalReads","If available, the total number of reads collected from samtools.","optional","","" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","optional","#Tumor","" +"workflow","Name and version of the workflow used to generate/analyze the data","optional","","" +"workflowLink","Workflow URL reference","optional","","" +"entityId",NA,NA,NA,NA diff --git a/docs/templates/Processed_Expression_Template.csv b/docs/templates/Processed_Expression_Template.csv new file mode 100644 index 00000000..32d34d14 --- /dev/null +++ b/docs/templates/Processed_Expression_Template.csv @@ -0,0 +1,23 @@ +"Field","Description","Required","ControlledVocab","Note" +"Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" +"Filename","The name of the file.","required","","Automatically filled when using the curator app." +"assay","The technology used to generate the data in this file","required","#Assay","" +"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.","required","#Data_Level","" +"dataType","A type of experimental, clinical, or other data. This 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`.","required","#Data","" +"expressionUnit","Measure used for transcript expression quantification","required","TPM,RPKM,FPKM,Counts,Other","" +"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","required","#File_Format","" +"resourceType","The type of resource being stored and annotated","required","#Resource","" +"age","A numeric value representing age of the individual. Use with ageUnit.","optional","","" +"ageUnit","A time unit that can be used with a given age value, e.g. years.","optional","days, months, years","" +"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","optional","#Diagnosis","Currently a single NF diagnosis allowed; in the future multiple diagnoses may be allowed for comorbidities." +"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." +"nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" +"sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","optional","#Sex","" +"species","The name of a species (typically a taxonomic group) of organism.","optional","#Species","" +"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. This can be the A A unique identifier (non-PII) that represents the","optional","","Typically annotated with a single ID, but many allowed for summary data." +"workflow","Name and version of the workflow used to generate/analyze the data","optional","","" +"workflowLink","Workflow URL reference","optional","","" +"entityId",NA,NA,NA,NA diff --git a/docs/templates/Processed_Variant_Calls_Template.csv b/docs/templates/Processed_Variant_Calls_Template.csv new file mode 100644 index 00000000..12ed2260 --- /dev/null +++ b/docs/templates/Processed_Variant_Calls_Template.csv @@ -0,0 +1,22 @@ +"Field","Description","Required","ControlledVocab","Note" +"Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" +"Filename","The name of the file.","required","","Automatically filled when using the curator app." +"assay","The technology used to generate the data in this file","required","#Assay","" +"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.","required","#Data_Level","" +"dataType","A type of experimental, clinical, or other data. This 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`.","required","#Data","" +"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","required","#File_Format","" +"resourceType","The type of resource being stored and annotated","required","#Resource","" +"age","A numeric value representing age of the individual. Use with ageUnit.","optional","","" +"ageUnit","A time unit that can be used with a given age value, e.g. years.","optional","days, months, years","" +"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","optional","#Diagnosis","Currently a single NF diagnosis allowed; in the future multiple diagnoses may be allowed for comorbidities." +"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." +"nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" +"sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","optional","#Sex","" +"species","The name of a species (typically a taxonomic group) of organism.","optional","#Species","" +"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. This can be the A A unique identifier (non-PII) that represents the","optional","","Typically annotated with a single ID, but many allowed for summary data." +"workflow","Name and version of the workflow used to generate/analyze the data","optional","","" +"workflowLink","Workflow URL reference","optional","","" +"entityId",NA,NA,NA,NA diff --git a/docs/templates/Proteomics_Assay_Template.csv b/docs/templates/Proteomics_Assay_Template.csv index ba2950c4..45e4c65d 100644 --- a/docs/templates/Proteomics_Assay_Template.csv +++ b/docs/templates/Proteomics_Assay_Template.csv @@ -1,14 +1,35 @@ "Field","Description","Required","ControlledVocab","Note" "Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" "Filename","The name of the file.","required","","Automatically filled when using the curator app." -"resourceType","The type of resource being stored and annotated","required","#Resource","" -"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" -"dataType","A type of experimental, clinical, or other data. This typically refers to a high-level data type, that is paired with a specific assay. For example, a file of dataType of """"genomicVariants"""" might have an assay value of """"whole genome sequencing"""". ","required","#Data","" "assay","The technology used to generate the data in this file","required","#Assay","" -"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" -"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." -"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" +"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.","required","#Data_Level","" +"dataType","A type of experimental, clinical, or other data. This 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`.","required","#Data","" +"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","required","#File_Format","" +"proteinExtractSource","Source of the extracted protein used in the experiment","required","cell lysate, nuclei, mitochondria, cytoplasm","" +"resourceType","The type of resource being stored and annotated","required","#Resource","" +"age","A numeric value representing age of the individual. Use with ageUnit.","optional","","" +"ageUnit","A time unit that can be used with a given age value, e.g. years.","optional","days, months, years","" +"aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID. ","optional","","" +"cellType","A cell type is a distinct morphological or functional form of cell.","optional","#Cell","" +"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","optional","#Diagnosis","Currently a single NF diagnosis allowed; in the future multiple diagnoses may be allowed for comorbidities." "experimentalCondition","A free-text description of the experimental condition (e.g. 5 mM doxorubicin).","optional","","" "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","optional","","" -"proteinExtractSource","Source of the extracted protein used in the experiment","required","cell lysate, nuclei, mitochondria, cytoplasm","" -"comments ",NA,NA,NA,NA +"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." +"isCellLine","Whether or not sample source is a cell line (Yes; No)","optional","Yes, No","" +"isPrimaryCell","Whether or not cellType is primary (Yes; No)","optional","Yes, No","" +"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): HEK293T (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","optional","#Model_System","" +"nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"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.","optional","#Organ","" +"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" +"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" +"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" +"sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","optional","#Sex","" +"species","The name of a species (typically a taxonomic group) of organism.","optional","#Species","" +"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. This can be the A A unique identifier (non-PII) that represents the","optional","","Typically annotated with a single ID, but many allowed for summary data." +"specimenPreparationMethod","Term that represents preservation of the sample before usage in, e.g. sequencing","optional","#Specimen_State","" +"timePointUnit","For timed experiments this represents the unit of time measured","optional","#Time_Unit","" +"tissue","A tissue is a mereologically maximal collection of cells that together perform physiological function.","optional","#Tissue","" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","optional","#Tumor","" +"entityId",NA,NA,NA,NA diff --git a/docs/templates/Protocol_Template.csv b/docs/templates/Protocol_Template.csv deleted file mode 100644 index d0d8c33c..00000000 --- a/docs/templates/Protocol_Template.csv +++ /dev/null @@ -1,8 +0,0 @@ -"Field","Description","Required","ControlledVocab","Note" -"Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" -"Filename","The name of the file.","required","","Automatically filled when using the curator app." -"resourceType","The type of resource being stored and annotated","required","#Resource","" -"author","The author of the resource; preferably use an ORCID ID, GitHub profile link, etc., if available and a text name if not.","optional","","" -"citation",NA,NA,NA,NA -"license","Link to a license or name of license applicable for the resource.",NA,"","" -"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" diff --git a/docs/templates/RNASeq_Template.csv b/docs/templates/RNASeq_Template.csv new file mode 100644 index 00000000..f1011f1d --- /dev/null +++ b/docs/templates/RNASeq_Template.csv @@ -0,0 +1,43 @@ +"Field","Description","Required","ControlledVocab","Note" +"Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" +"Filename","The name of the file.","required","","Automatically filled when using the curator app." +"assay","The technology used to generate the data in this file","required","#Assay","" +"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.","required","#Data_Level","" +"dataType","A type of experimental, clinical, or other data. This 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`.","required","#Data","" +"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","required","#File_Format","" +"readLength","Number of base pairs (bp) sequenced for a read","required","","" +"resourceType","The type of resource being stored and annotated","required","#Resource","" +"age","A numeric value representing age of the individual. Use with ageUnit.","optional","","" +"ageUnit","A time unit that can be used with a given age value, e.g. years.","optional","days, months, years","" +"aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID. ","optional","","" +"cellType","A cell type is a distinct morphological or functional form of cell.","optional","#Cell","" +"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","optional","#Diagnosis","Currently a single NF diagnosis allowed; in the future multiple diagnoses may be allowed for comorbidities." +"dissociationMethod","Procedure by which a biological specimen is dissociated into individual cells or a cell suspension","optional","#Dissociation_Method","" +"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." +"isCellLine","Whether or not sample source is a cell line (Yes; No)","optional","Yes, No","" +"isPrimaryCell","Whether or not cellType is primary (Yes; No)","optional","Yes, No","" +"isStranded","Whether or not the library is stranded (Yes; No)","optional","Yes, No","" +"libraryPrep","The general strategy by which the library was prepared","optional","#Library_Prep","" +"libraryPreparationMethod","Method by which library was prepared","optional","#Library_Preparation_Method","" +"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): HEK293T (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","optional","#Model_System","" +"nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nucleicAcidSource","Source of the extracted nucleic acid used in the experiment","optional","#Nucleic_Acid_Source","" +"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.","optional","#Organ","" +"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" +"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" +"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" +"readDepth","If available, the coverage statistic as output from bedtools coverage or samtools stats.","optional","","" +"readPair","The read of origin","optional","#Read_Pair","" +"readPairOrientation","The relative orientation of the reads in a paired-end protocol","optional","#Read_Pair_Orientation","" +"readStrandOrigin","The strand from which the read originates in a strand-specific protocol","optional","#Read_Strand_Origin","" +"runType","Is the sequencing run single or paired end?","optional","#Run_Type","" +"sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","optional","#Sex","" +"species","The name of a species (typically a taxonomic group) of organism.","optional","#Species","" +"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. This can be the A A unique identifier (non-PII) that represents the","optional","","Typically annotated with a single ID, but many allowed for summary data." +"specimenPreparationMethod","Term that represents preservation of the sample before usage in, e.g. sequencing","optional","#Specimen_State","" +"targetDepth","The targeted read depth prior to sequencing.","optional","","" +"tissue","A tissue is a mereologically maximal collection of cells that together perform physiological function.","optional","#Tissue","" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","optional","#Tumor","" +"entityId",NA,NA,NA,NA diff --git a/docs/templates/ScRNASeq_Template.csv b/docs/templates/ScRNASeq_Template.csv new file mode 100644 index 00000000..bc0bb804 --- /dev/null +++ b/docs/templates/ScRNASeq_Template.csv @@ -0,0 +1,42 @@ +"Field","Description","Required","ControlledVocab","Note" +"Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" +"Filename","The name of the file.","required","","Automatically filled when using the curator app." +"assay","The technology used to generate the data in this file","required","#Assay","" +"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.","required","#Data_Level","" +"dataType","A type of experimental, clinical, or other data. This 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`.","required","#Data","" +"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","required","#File_Format","" +"readLength","Number of base pairs (bp) sequenced for a read","required","","" +"resourceType","The type of resource being stored and annotated","required","#Resource","" +"age","A numeric value representing age of the individual. Use with ageUnit.","optional","","" +"ageUnit","A time unit that can be used with a given age value, e.g. years.","optional","days, months, years","" +"aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID. ","optional","","" +"cellType","A cell type is a distinct morphological or functional form of cell.","optional","#Cell","" +"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","optional","#Diagnosis","Currently a single NF diagnosis allowed; in the future multiple diagnoses may be allowed for comorbidities." +"dissociationMethod","Procedure by which a biological specimen is dissociated into individual cells or a cell suspension","optional","#Dissociation_Method","" +"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." +"isCellLine","Whether or not sample source is a cell line (Yes; No)","optional","Yes, No","" +"isPrimaryCell","Whether or not cellType is primary (Yes; No)","optional","Yes, No","" +"isStranded","Whether or not the library is stranded (Yes; No)","optional","Yes, No","" +"libraryPrep","The general strategy by which the library was prepared","optional","#Library_Prep","" +"libraryPreparationMethod","Method by which library was prepared","optional","#Library_Preparation_Method","" +"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): HEK293T (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","optional","#Model_System","" +"nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nucleicAcidSource","Source of the extracted nucleic acid used in the experiment","optional","#Nucleic_Acid_Source","" +"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.","optional","#Organ","" +"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" +"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" +"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" +"readDepth","If available, the coverage statistic as output from bedtools coverage or samtools stats.","optional","","" +"readPair","The read of origin","optional","#Read_Pair","" +"readPairOrientation","The relative orientation of the reads in a paired-end protocol","optional","#Read_Pair_Orientation","" +"readStrandOrigin","The strand from which the read originates in a strand-specific protocol","optional","#Read_Strand_Origin","" +"runType","Is the sequencing run single or paired end?","optional","#Run_Type","" +"sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","optional","#Sex","" +"species","The name of a species (typically a taxonomic group) of organism.","optional","#Species","" +"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. This can be the A A unique identifier (non-PII) that represents the","optional","","Typically annotated with a single ID, but many allowed for summary data." +"specimenPreparationMethod","Term that represents preservation of the sample before usage in, e.g. sequencing","optional","#Specimen_State","" +"tissue","A tissue is a mereologically maximal collection of cells that together perform physiological function.","optional","#Tissue","" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","optional","#Tumor","" +"entityId",NA,NA,NA,NA diff --git a/docs/templates/Source_Code_Template.csv b/docs/templates/Source_Code_Template.csv index d76b5da6..af1609ac 100644 --- a/docs/templates/Source_Code_Template.csv +++ b/docs/templates/Source_Code_Template.csv @@ -1,8 +1,10 @@ "Field","Description","Required","ControlledVocab","Note" "Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" "Filename","The name of the file.","required","","Automatically filled when using the curator app." +"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","required","#File_Format","" "resourceType","The type of resource being stored and annotated","required","#Resource","" -"programmingLanguage","A computer programming language","optional","Python, R, MATLAB, Java, C, C++, C#, Javascript, bash","" +"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" "documentation","URL to any documentation describing the resource and its use.","optional","","" +"programmingLanguage","A computer programming language","optional","Python, R, MATLAB, Java, C, C++, C#, Javascript, bash","" "runtimePlatform","Runtime platform or script interpreter dependencies (e.g. Java v1, Python 2.3).","optional","","" -"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"entityId",NA,NA,NA,NA diff --git a/docs/templates/Update_Milestone_Report.csv b/docs/templates/Update_Milestone_Report.csv deleted file mode 100644 index ab02359f..00000000 --- a/docs/templates/Update_Milestone_Report.csv +++ /dev/null @@ -1,5 +0,0 @@ -"Field","Description","Required","ControlledVocab","Note" -"Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" -"Filename","The name of the file.","required","","Automatically filled when using the curator app." -"resourceType","The type of resource being stored and annotated","required","#Resource","" -"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" diff --git a/docs/templates/WES_Template.csv b/docs/templates/WES_Template.csv new file mode 100644 index 00000000..e7ef0015 --- /dev/null +++ b/docs/templates/WES_Template.csv @@ -0,0 +1,43 @@ +"Field","Description","Required","ControlledVocab","Note" +"Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" +"Filename","The name of the file.","required","","Automatically filled when using the curator app." +"assay","The technology used to generate the data in this file","required","#Assay","" +"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.","required","#Data_Level","" +"dataType","A type of experimental, clinical, or other data. This 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`.","required","#Data","" +"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","required","#File_Format","" +"readLength","Number of base pairs (bp) sequenced for a read","required","","" +"resourceType","The type of resource being stored and annotated","required","#Resource","" +"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.","required","","For WES processing, the target BED used could be provided based on the target capture kit." +"age","A numeric value representing age of the individual. Use with ageUnit.","optional","","" +"ageUnit","A time unit that can be used with a given age value, e.g. years.","optional","days, months, years","" +"aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID. ","optional","","" +"cellType","A cell type is a distinct morphological or functional form of cell.","optional","#Cell","" +"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","optional","#Diagnosis","Currently a single NF diagnosis allowed; in the future multiple diagnoses may be allowed for comorbidities." +"dissociationMethod","Procedure by which a biological specimen is dissociated into individual cells or a cell suspension","optional","#Dissociation_Method","" +"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." +"isCellLine","Whether or not sample source is a cell line (Yes; No)","optional","Yes, No","" +"isPrimaryCell","Whether or not cellType is primary (Yes; No)","optional","Yes, No","" +"isStranded","Whether or not the library is stranded (Yes; No)","optional","Yes, No","" +"libraryPrep","The general strategy by which the library was prepared","optional","#Library_Prep","" +"libraryPreparationMethod","Method by which library was prepared","optional","#Library_Preparation_Method","" +"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): HEK293T (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","optional","#Model_System","" +"nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nucleicAcidSource","Source of the extracted nucleic acid used in the experiment","optional","#Nucleic_Acid_Source","" +"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.","optional","#Organ","" +"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" +"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" +"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" +"readDepth","If available, the coverage statistic as output from bedtools coverage or samtools stats.","optional","","" +"readPair","The read of origin","optional","#Read_Pair","" +"readPairOrientation","The relative orientation of the reads in a paired-end protocol","optional","#Read_Pair_Orientation","" +"readStrandOrigin","The strand from which the read originates in a strand-specific protocol","optional","#Read_Strand_Origin","" +"runType","Is the sequencing run single or paired end?","optional","#Run_Type","" +"sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","optional","#Sex","" +"species","The name of a species (typically a taxonomic group) of organism.","optional","#Species","" +"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. This can be the A A unique identifier (non-PII) that represents the","optional","","Typically annotated with a single ID, but many allowed for summary data." +"specimenPreparationMethod","Term that represents preservation of the sample before usage in, e.g. sequencing","optional","#Specimen_State","" +"tissue","A tissue is a mereologically maximal collection of cells that together perform physiological function.","optional","#Tissue","" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","optional","#Tumor","" +"entityId",NA,NA,NA,NA diff --git a/docs/templates/WGS_Template.csv b/docs/templates/WGS_Template.csv new file mode 100644 index 00000000..bc0bb804 --- /dev/null +++ b/docs/templates/WGS_Template.csv @@ -0,0 +1,42 @@ +"Field","Description","Required","ControlledVocab","Note" +"Component","Category of metadata manifest; provide the same one for all items/rows.","required","","" +"Filename","The name of the file.","required","","Automatically filled when using the curator app." +"assay","The technology used to generate the data in this file","required","#Assay","" +"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.","required","#Data_Level","" +"dataType","A type of experimental, clinical, or other data. This 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`.","required","#Data","" +"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","required","#File_Format","" +"readLength","Number of base pairs (bp) sequenced for a read","required","","" +"resourceType","The type of resource being stored and annotated","required","#Resource","" +"age","A numeric value representing age of the individual. Use with ageUnit.","optional","","" +"ageUnit","A time unit that can be used with a given age value, e.g. years.","optional","days, months, years","" +"aliquotID","A unique identifier (non-PII) that represents the aliquots used for e.g. replicate runs. This is linked to the specimenID. ","optional","","" +"cellType","A cell type is a distinct morphological or functional form of cell.","optional","#Cell","" +"comments","Brief free-text comments that may also be important to understanding the resource.","optional","","" +"diagnosis","A diagnosis is the result of a medical investigation to identify a disorder from its signs and symptoms.","optional","#Diagnosis","Currently a single NF diagnosis allowed; in the future multiple diagnoses may be allowed for comorbidities." +"dissociationMethod","Procedure by which a biological specimen is dissociated into individual cells or a cell suspension","optional","#Dissociation_Method","" +"individualID","A unique identifier (non-PII) that represents the individual from which the data came. This could be a patient or animal ID.","optional","","Typically annotated with a single ID, but many allowed for, e.g. a clinical dataset that contains endpoint data for an entire cohort." +"isCellLine","Whether or not sample source is a cell line (Yes; No)","optional","Yes, No","" +"isPrimaryCell","Whether or not cellType is primary (Yes; No)","optional","Yes, No","" +"isStranded","Whether or not the library is stranded (Yes; No)","optional","Yes, No","" +"libraryPrep","The general strategy by which the library was prepared","optional","#Library_Prep","" +"libraryPreparationMethod","Method by which library was prepared","optional","#Library_Preparation_Method","" +"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): HEK293T (cell line), Minnesota5 (swine strain), DXL (poultry strain), RB51 (vaccine strain of Brucella abortus)","optional","#Model_System","" +"nf1Genotype","Genotype of NF1 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nf2Genotype","Genotype of NF2 gene in the biospecimen from which the data were derived, if known","optional","#Genotype","" +"nucleicAcidSource","Source of the extracted nucleic acid used in the experiment","optional","#Nucleic_Acid_Source","" +"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.","optional","#Organ","" +"parentSpecimenID","A unique identifier (non-PII) that represents the parent specimen (sample) from which the data came from, e.g. the single parent tumor. The parentSpecimenIDcan be the same as specimenID when there is no subsectioning.","optional","","" +"platform","A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","optional","#Platform","" +"progressReportNumber","Indicates milestone the data is associated with. Currently only required for projects funded by NTAP, GFF, and NFRI. For GFF studies, this is the ‘progress report’ timeline. Example: if submitting data for the 6-month milestone report for NTAP, progressReportNumber=1. Also if submitting data associated with first milestone, progressReportNumber =1","optional","1, 2, 3, 4, 5, 6, 7, 8, 9, 10, Not Applicable","" +"readDepth","If available, the coverage statistic as output from bedtools coverage or samtools stats.","optional","","" +"readPair","The read of origin","optional","#Read_Pair","" +"readPairOrientation","The relative orientation of the reads in a paired-end protocol","optional","#Read_Pair_Orientation","" +"readStrandOrigin","The strand from which the read originates in a strand-specific protocol","optional","#Read_Strand_Origin","" +"runType","Is the sequencing run single or paired end?","optional","#Run_Type","" +"sex","Phenotypic expression of chromosomal makeup that defines a study subject as male, female, or other.","optional","#Sex","" +"species","The name of a species (typically a taxonomic group) of organism.","optional","#Species","" +"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. This can be the A A unique identifier (non-PII) that represents the","optional","","Typically annotated with a single ID, but many allowed for summary data." +"specimenPreparationMethod","Term that represents preservation of the sample before usage in, e.g. sequencing","optional","#Specimen_State","" +"tissue","A tissue is a mereologically maximal collection of cells that together perform physiological function.","optional","#Tissue","" +"tumorType","The type of tumor that the biospecimen used to generate the data were collected from.","optional","#Tumor","" +"entityId",NA,NA,NA,NA diff --git a/modules/Assay/annotationProperty.csv b/modules/Assay/annotationProperty.csv index 03278372..6c9fefc1 100644 --- a/modules/Assay/annotationProperty.csv +++ b/modules/Assay/annotationProperty.csv @@ -2,6 +2,7 @@ Attribute,Description,Valid Values,DependsOn,Required,Source,Parent,Properties,D drugScreenType,String describing general class of drug screen,"singleMolecule, smallMoleculeLibraryScreen, combinationLibraryScreen, combinationScreen",,FALSE,,compoundScreen,,,,drugScreenType,Property,Assay,annotationProperty,,,, assay,The technology used to generate the data in this file,"elevated plus maze test, open field test, rotarod performance test, mRNAcounts, high content screen, Immunocytochemistry, immunofluorescence, autoradiography, electrochemiluminescence, Real Time PCR, in vivo tumor growth, scale, Blood Chemistry Measurement, in vivo bioluminescence, immunohistochemistry, NOMe-Seq, FIA-MSMS, UPLC-MSMS, HPLC-MSMS, liquid chromatography-electrochemical detection, rnaSeq, mirnaSeq, LC-MSMS, LC-MS, lncrnaSeq, Whole Exome Sequencing, Sanger sequencing, ChIPSeq, rnaArray, snpArray, methylationArray, mirnaArray, bisulfiteSeq, ATACSeq, HI-C, errBisulfiteSeq, ISOSeq, westernBlot, wholeGenomeSeq, polymeraseChainReaction, cellViabilityAssay, atomicForceMicroscopy, brightfieldMicroscopy, tractionForceMicroscopy, nextGenerationTargetedSequencing, jumpingLibrary, MIB/MS, scCGIseq, MudPIT, questionnaire, DNA optical mapping, oxBS-Seq, Ribo-Seq, Positron Emission Tomography, RPPA, ELISA, LTP, LFP, whole-cell patch clamp, sandwich ELISA, Laser Speckle Imaging, Genotyping, TMT quantitation, label free mass spectrometry, cell count, reporter gene assay, Single Cell RNA Sequencing, spatial transcriptomics, Conventional MRI, Functional MRI, Magnetic Resonance Spectroscopy, 2D Incucyte, 2D CellTiter-Glo, 3D microtissue viability, in vivo PDX viability, 2D AlamarBlue fluorescence, 2D AlamarBlue absorbance, rheometry, FTIR Spectroscopy, differential scanning calorimetry, Gel filtration chromatography, Massively Parallel Reporter Assay,Riccardi and Ablon scales,Spatial Frequency Domain Imaging,Optical Coherence Tomography",,TRUE,,experimentalData,,,,assayType,Property,Assay,annotationProperty,,Assay,one, platform,"A sequencing platform, microscope, spectroscope/plate reader, or other platform for collecting data. ","HiSeq3000, HiSeq2500, HiSeq4000, NextSeq500, HiSeq2000, MiSeq, Zeiss LSM 980, Affy5.0, Affy6.0, PacBioRSII, GAIIx, Illumina_HumanOmni1-Quadv1.0, Illumina_1M, Illumina_h650, Illumina_Omni2pt5M, Illumina_Omni5M, Illumina MouseWG-6 v2.0 expression beadchip, Perlegen300Karray, Agilent44Karray, IlluminaWholeGenomeDASL, IlluminaHumanHap300, NanostringnCounter, LTQOrbitrapXL, IlluminaHumanMethylation450, Illumina Infinium MethylationEPIC BeadChip, AffymetrixU133AB, Affymetrix Human Gene 1.0 ST Array, AffymetrixU133Plus2, HiSeqX, Bionano Irys, Infinium HumanOmniExpressExome, NextSeq 550, NextSeq 1000, NextSeq 2000, PacBio Sequel IIe System, PacBio Sequel II System, NanostringGeoMx, LI-COR Odyssey CLx, Spectramax M Series, Olympus DP80, Orbitrap Fusion Lumos Tribrid, Illumina NovaSeq 6000, Chromium X,EnVision 2103 Multiplate Reader,Vectra H1 3D Imaging System,Vevo 3100 Imaging System,10x Visium Spatial Gene Expression",,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=read_group&anchor=platform,experimentalData,,,,platform,Property,Assay,annotationProperty,,Platform,, +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.",,,TRUE,http://purl.obolibrary.org/obo/NCIT_C177583,experimentalData,,,,targetCaptureKitID,Property,Assay,annotationProperty,,,,"For WES processing, the target BED used could be provided based on the target capture kit." libraryID,,,,TRUE,,experimentalData,,,,libraryID,Property,Assay,annotationProperty,,,, assayTarget,The HUGO gene symbol that represents the target analyte assayed.,,,FALSE,Sage Bionetworks,experimentalData,,,,assayTarget,Property,Assay,annotationProperty,,,, proteinExtractSource,Source of the extracted protein used in the experiment,"cell lysate, nuclei, mitochondria, cytoplasm",,TRUE,http://purl.obolibrary.org/obo/OBI_0000894,experimentalData,,,,proteinExtractSource,Property,Assay,annotationProperty,,,, @@ -17,6 +18,8 @@ libraryPrep,The general strategy by which the library was prepared,"rRNAdepletio libraryPreparationMethod,Method by which library was prepared,"10x, CEL-seq, Drop-Seq, Smart-seq2, TruSeq, Smart-seq4, Omni-ATAC, NEBNext mRNA Library Prep Reagent Set for Illumina, IDT xGen Exome Research Panel, TruSeq standard total RNA library kit, Illumina TruSeq DNA Nano, KAPA HyperPrep Kit PCR-free,KAPA RNA HyperPrep Kit with RiboErase (HMR),GTAC@WUSTL in-house prep",,FALSE,,ngs,,,,libraryPreparationMethod,Property,Assay,annotationProperty,ngsParameter,Library_Preparation_Method,, nucleicAcidSource,Source of the extracted nucleic acid used in the experiment,"bulk cell, single cell, bulk nuclei, single nucleus, mitochondria",,FALSE,Sage Bionetworks,ngs,,,,nucleicAcidSource,Property,Assay,annotationProperty,ngsParameter,Nucleic_Acid_Source,, dissociationMethod,Procedure by which a biological specimen is dissociated into individual cells or a cell suspension,"10x_v2, FACS, Fluidigm C1, drop-seq, inDrop, mouth pipette, bulk, enzymatic, mechanical, none",,FALSE,https://www.ebi.ac.uk/ols/ontologies/efo/terms?iri=http%3A%2F%2Fwww.ebi.ac.uk%2Fefo%2FEFO_0009088,ngs,,,,dissociationMethod,Property,Assay,annotationProperty,ngsParameter,Dissociation_Method,, -readLength,Number of base pairs (bp) sequenced for a read,,,FALSE,,ngs,,,,readLength,DataProperty,Assay,annotationProperty,ngsParameter,,, -readDepth,"If available, coverage statistic as output from bedtools coverage or samtools stats.",,,FALSE,Sage Bionetworks,ngs,,,,readDepth,DataProperty,Assay,annotationProperty,ngsParameter,,, -isPairedEnd,"(Legacy/deprecated annotation) Whether or not is paired-end sequencing (Yes; No). Note that this can be inferred as 'Yes' when runType=pairedEnd; current templates actually use runType to capture this info.","Yes, No",,FALSE,,ngs,,,,isPairedEnd,DataProperty,Assay,annotationProperty,ngsParameter,,, +readLength,Number of base pairs (bp) sequenced for a read,,,TRUE,,ngs,,,,readLength,DataProperty,Assay,annotationProperty,ngsParameter,,, +readDepth,"If available, the coverage statistic as output from bedtools coverage or samtools stats.",,,FALSE,Sage Bionetworks,ngs,,,,readDepth,DataProperty,Assay,annotationProperty,ngsParameter,,, +isPairedEnd,(Legacy/deprecated annotation) Whether or not is paired-end sequencing (Yes; No). Note that this can be inferred as 'Yes' when runType=pairedEnd; current templates actually use runType to capture this info.,"Yes, No",,FALSE,,ngs,,,,isPairedEnd,DataProperty,Assay,annotationProperty,ngsParameter,,, +totalReads,"If available, the total number of reads collected from samtools.",,,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads&anchor=total_reads,ngs,,,,totalReads,DataProperty,Assay,annotationProperty,ngsParameter,,, +targetDepth,"The targeted read depth prior to sequencing.",,,FALSE,https://data.humantumoratlas.org/standards/bulkrnaseq#TargetDepth,ngs,,,,targetDepth,DataProperty,Assay,annotationProperty,ngsParameter,,, diff --git a/modules/Data/Data_Class.csv b/modules/Data/Data_Class.csv index 8564538c..f962a126 100644 --- a/modules/Data/Data_Class.csv +++ b/modules/Data/Data_Class.csv @@ -3,8 +3,13 @@ raw counts,The number or amount of something.,"",assay,FALSE,http://purl.obolibr Volume,The amount of three dimensional space occupied by an object or the capacity of a space or container.,"",assay,FALSE,http://purl.obolibrary.org/obo/NCIT_C25335,dataType,,"","",Volume,Class,Data,Data_Class,"","","","" Weight,The vertical force exerted by a mass as a result of gravity.,"",assay,FALSE,http://purl.obolibrary.org/obo/NCIT_C25208,dataType,,"","",Weight,Class,Data,Data_Class,"","","","" Pharmacokinetic Study,"A study of the process by which a drug is absorbed, distributed, metabolized, and eliminated by the body.","",assay,FALSE,http://purl.obolibrary.org/obo/NCIT_C49663,dataType,,"","",Pharmacokinetic_Study,Class,Data,Data_Class,"","","","" -genomicVariants,"Genomic alterations, including single nucleotide polymorphisms, short indels and structural variants, in a genome sequence.","",assay,FALSE,https://www.ebi.ac.uk/ols/ontologies/edam/terms?iri=http%3A%2F%2Fedamontology.org%2Foperation_3227,dataType,,"","",Genomic_Variants,Class,Data,Data_Class,"","","","" -behavior process,"The action, reaction, or performance of an organism in response to external or internal stimuli.","",assay,FALSE,http://purl.obolibrary.org/obo/NBO_0000313,dataType,,"","",Behavior_Process,Class,Data,Data_Class,"","","","" +genomicVariants,"Genomic alterations, including single nucleotide polymorphisms, short indels and structural variants. Use more specific term if possible, esp. if data is only of one specific subset.","",assay,FALSE,https://www.ebi.ac.uk/ols/ontologies/edam/terms?iri=http%3A%2F%2Fedamontology.org%2Foperation_3227,dataType,,"","",Genomic_Variants,Class,Data,Data_Class,"","","","" +AlignedReads,"Aligned reads output from alignment workflows","",assay,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads,dataType,,"","",Aligned_Reads,Class,Data,Data_Class,"","","","" +SomaticVariants,"Specifically genomic variants data that includes somatic variants and excludes germline variants","",assay,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=simple_somatic_mutation,dataType,,"","",Somatic_Variants,Class,Data,Data_Class,"",,"","" +AnnotatedSomaticVariants,"Specifically genomic variants data that includes somatic variants with annotations added from some annotation workflow","",assay,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=annotated_somatic_mutation,dataType,,"","",Annotated_Somatic_Variants,Class,Data,Data_Class,"","","","" +GermlineVariants,"Specifically genomic variants data that includes called germline variants","",assay,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=simple_germline_variation,dataType,,"","",Germline_Variants,Class,Data,Data_Class,"","","","" +StructuralVariants,"Specifically genomic variants data classified as structural variants, which may be derived from specialized variant calling workflows","",assay,FALSE,,dataType,,"","",Structural_Variants,Class,Data,Data_Class,"","","","" +behavior process,"The action, reaction, or performance of an organism in response to external or internal stimuli.","",assay,FALSE,hhttps://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=structural_variation,dataType,,"","",Behavior_Process,Class,Data,Data_Class,"","","","" metabolomics,"The systematic study of metabolites, the chemical processes they are involved, and the chemical fingerprints of specific cellular processes in a whole cell, tissue, organ or organism.","",assay,FALSE,http://edamontology.org/topic_3172,dataType,,"","",Metabolomics,Class,Data,Data_Class,"","","","" image,Biological or biomedical data that has been rendered into an image.,"",assay,FALSE,https://www.ebi.ac.uk/ols/ontologies/edam/terms?iri=http%3A%2F%2Fedamontology.org%2Fdata_2968,dataType,,"","",Image,Class,Data,Data_Class,"","","","" geneExpression,The analysis of levels and patterns of synthesis of gene products (proteins and functional RNA) including interpretation in functional terms of gene expression data.,"",assay,FALSE,https://www.ebi.ac.uk/ols/ontologies/edam/terms?iri=http%3A%2F%2Fedamontology.org%2Ftopic_0203,dataType,,"","",Gene_Expression,Class,Data,Data_Class,"","","","" diff --git a/modules/Data/annotationProperty.csv b/modules/Data/annotationProperty.csv index e86cea5a..b1221613 100644 --- a/modules/Data/annotationProperty.csv +++ b/modules/Data/annotationProperty.csv @@ -2,9 +2,10 @@ Attribute,Description,Valid Values,DependsOn,Required,Source,Parent,Properties,D curatedDataType,The type of information being curated.,"reference sequence, gene symbol, clinical data, gene function, chemical descriptor",,TRUE,,curatedData,,,,curatedDataType,Property,Data,annotationProperty,,,, referenceSet,"A set of references (e.g., canonical assembled contigs) which defines a common coordinate space for comparing reference-aligned experimental data.","GRCh38, GRCh37, MMUL1.0, HRC",,TRUE,,curatedData,,,,referenceSet,Property,Data,annotationProperty,,,, reference sequence,Syntactic sequences that has a role as reference of an annotation.,,,FALSE,http://rdf.biosemantics.org/ontologies/rsa#ReferenceSequence,curatedDataType,,,,referenceSequence,Property,Data,annotationProperty,,,, -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.","normalized, dataMatrix, raw, processed, metadata, representative",,TRUE,,experimentalData,,,,dataSubtype,Property,Data,annotationProperty,,Data,one, +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.","normalized, dataMatrix, raw, processed, metadata, representative",,TRUE,,experimentalData,,,,dataSubtype,Property,Data,annotationProperty,,Data_Level,one, metadataType,"For files of dataSubtype: metadata, a description of the type of metadata in the file.","individual, biospecimen, assay, data dictionary, manifest, protocol",,FALSE,,experimentalData,,,,metadataType,Property,Data,annotationProperty,,,, -dataType,"A type of experimental, clinical, or other data. This typically refers to a high-level data type, that is paired with a specific assay. For example, a file of dataType of """"genomicVariants"""" might have an assay value of """"whole genome sequencing"""". ","Volume, Weight, Pharmacokinetic Study, genomicVariants, behavior process, metabolomics, image, geneExpression, isoformExpression, proteomics, kinomics, drugScreen, drugCombinationScreen, cellularPhysiology, chromatinActivity, surveyData, network, clinical, immunoassay, electrophysiology, raw counts, mask image",dataSubtype,TRUE,,experimentalData,,,,dataType,Property,Data,annotationProperty,,Data,one, +dataType,"A type of experimental, clinical, or other data. This 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`.","Volume, Weight, Pharmacokinetic Study, genomicVariants,behavior process, metabolomics, image, geneExpression, isoformExpression, proteomics, kinomics, drugScreen, drugCombinationScreen, cellularPhysiology, chromatinActivity, surveyData, network, clinical, immunoassay, electrophysiology, raw counts, mask image,AlignedReads,SomaticVariants,AnnotatedSomaticVariants,StructuralVariants,GermlineVariants",dataSubtype,TRUE,,experimentalData,,,,dataType,Property,Data,annotationProperty,,Data,one, +expressionUnit,"Measure used for transcript expression quantification","TPM,RPKM,FPKM,Counts,Other",,TRUE,,experimentalData,,,,expressionUnit,DataProperty,Data,annotationProperty,,,, failedQC,Whether the sample or data failed QC checks (Yes; No),"Yes, No",,TRUE,,experimentalData,,,,failedQC,DataProperty,Data,annotationProperty,,,, Filename,The name of the file.,,"entityId,fileFormat",TRUE,Sage Bionetworks,NF,,,,fileName,Class,Data,annotationProperty,fileName,,one,Automatically filled when using the curator app. programmingLanguage,A computer programming language,"Python, R, MATLAB, Java, C, C++, C#, Javascript, bash",,FALSE,Sage Bionetworks,,,,,programmingLanguage,Property,Data,annotationProperty,ngsParameter,,, diff --git a/modules/Processing/annotationProperty.csv b/modules/Processing/annotationProperty.csv new file mode 100644 index 00000000..99402226 --- /dev/null +++ b/modules/Processing/annotationProperty.csv @@ -0,0 +1,13 @@ +Attribute,Description,Valid Values,DependsOn,Required,Source,Parent,Properties,DependsOn Component,Validation Rules,.ID,.Type,.Module,.Root,.SubOf,.Range,.Cardinality,.EditorNote +workflow,"Name and version of the workflow used to generate/analyze the data",,workflowLink,FALSE,,,,,,workflow,Property,Processing,annotationProperty,,,, +workflowLink,"Workflow URL reference",,,FALSE,,,,,,workflowLink,Property,Processing,annotationProperty,,,, +genomicReference,"Version of genome reference used for alignment in processing workflow",,,FALSE,,,,,,genomicReference,Property,Processing,annotationProperty,,,, +averageInsertSize,"Average insert size as reported by samtools",,,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads&anchor=average_insert_size,,,,,averageInsertSize,Property,Processing,annotationProperty,,,, +averageReadLength,"Average read length collected from samtools",,,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads&anchor=average_read_length,,,,,averageReadLength,Property,Processing,annotationProperty,,,, +averageBaseQuality,"Average base quality collected from samtools",,,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads&anchor=average_base_quality,,,,,averageBaseQuality,Property,Processing,annotationProperty,,,, +pairsOnDifferentChr,"Pairs on different chromosomes collected from samtools",,,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads&anchor=pairs_on_diff_chr,,,,,pairsOnDifferentChr,Property,Processing,annotationProperty,,,, +readsDuplicatedPercent,"Percent of duplicated reads collected from samtools",,,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads&anchor=proportion_reads_duplicated,,,,,readsDuplicatedPercent,Property,Processing,annotationProperty,,,, +readsMappedPercent,"Percent of mapped reads collected from samtools",,,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads&anchor=proportion_reads_mapped,,,,,readsMappedPercent,Property,Processing,annotationProperty,,,, +meanCoverage,"Mean coverage for whole genome sequencing, or mean target coverage for whole exome and targeted sequencing, collected from Picard Tools",,,FALSE,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads&anchor=mean_coverage,,,,,meanCoverage,Property,Processing,annotationProperty,,,, +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,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads&anchor=proportion_coverage_10x,,,,,proportionCoverage10x,Property,Processing,annotationProperty,,,, +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,https://docs.gdc.cancer.gov/Data_Dictionary/viewer/#?view=table-definition-view&id=aligned_reads&anchor=proportion_coverage_30x,,,,,proportionCoverage30x,Property,Processing,annotationProperty,,,, diff --git a/modules/Template/Template.csv b/modules/Template/Template.csv index f46c2a2b..b93160f8 100644 --- a/modules/Template/Template.csv +++ b/modules/Template/Template.csv @@ -1,28 +1,35 @@ -Attribute,Description,Valid Values,DependsOn,Required,Source,Parent,Properties,DependsOn Component,Validation Rules,.ID,.Type,.Module,.Root,.SubOf,.Range,.Cardinality,.EditorNote -genomicsAssayTemplate_Normalized,"Generic template for describing data from a genomic type assay (RNA-seq, Exome-seq, etc) WITHOUT full individual and biospecimen data. To link individual and biospecimen metadata, an additional “biospecimenTemplate_Default” must be additionally completed with either specimenID or aliquotID available for joining. This is a two-step template.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,specimenID,aliquotID,runType,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,Genomics_Assay_Template_Normalized,Class,Template,Template,Assay_Template,,, -genomicsAssayTemplate,"Generic denormalized template for describing data from a genomic type assay (RNA-seq, Exome-seq, etc) along with individual, biospecimen and experimental metadata. This is a one-step template.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,runType,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,Genomics_Assay_Template,Class,Template,Template,Assay_Template,,, -genomicsAssayTemplate_Extended,"Template for describing data from a genomic type assay (RNA-seq, Exome-seq, etc) with extended properties for capturing additional metadata such as gene perturbation parameters or experimental conditions and time points. This is a one-step template.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,runType,libraryPrep,genePerturbed,comments",TRUE,Sage Bionetworks,template,,,,Genomics_Assay_Template_Extended,Class,Template,Template,Assay_Template,,, -imagingAssayTemplate,"Generic template for describing data from an imaging type assay (IHC, etc). This is a one-step template.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,assay,platformTarget,individualID,parentSpecimenID,comments",TRUE,Sage Bionetworks,template,,,,Imaging_Assay_Template,Class,Template,Template,Assay_Template,,, -imagingAssayTemplate_Extended,"Template for describing data from an imaging type assay (IHC, etc) with extended properties for capturing additional metadata such as gene perturbation parameters or experimental conditions and time points.. This is a one-step template.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,assay,platformTarget,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,genePerturbed,comments",TRUE,Sage Bionetworks,template,,,,Imaging_Assay_Template_Extended,Class,Template,Template,Assay_Template,,, -MRIAssayTemplate,Generic template for describing data from an MRI assay. This is a one-step template.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,MRISequence,comments",TRUE,Sage Bionetworks,template,,,,MRI_Assay_Template,Class,Template,Template,Assay_Template,,, -epigeneticsAssayTemplate,Generic template for describing data from an epigenetics assay. This is a one-step template.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,Epigenetics_Assay_Template,Class,Template,Template,Assay_Template,,, -pharmacokineticsAssayTemplate,Generic template for describing data from a pharmacokinetics assay. This is a one-step template.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,assay,platformTarget,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,genePerturbed,comments",TRUE,Sage Bionetworks,template,,,,Pharmacokinetics_Assay_Template,Class,Template,Template,Assay_Template,,, -proteomicsAssayTemplate,Generic template for describing data from a proteomics assay. Note that specialized proteomics assays may have their own template to capture more detailed information. This is a one-step template.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,proteinExtractSource,comments ",TRUE,Sage Bionetworks,template,,,,Proteomics_Assay_Template,Class,Template,Template,Assay_Template,,, -plateBasedReporterAssayTemplate,Generic template for describing data from a plate-based reporter assay. This is a one-step template.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,assay,platformTarget,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,reporterGene,reporterSubstance,comments",TRUE,Sage Bionetworks,template,,,,Plate_Based_Reporter_Assay_Template,Class,Template,Template,Assay_Template,,, -patientTimepointsTemplate,Template for capturing individual-level metadata with time points. Do not use for data file annotation.,,"Component,individualID,experimentalTimepoint",TRUE,Sage Bionetworks,template,,,,Patient_Timepoints_Template,Class,Template,Template,Non_Assay_Template,,, -clinicalAssayTemplate,"Annotation template for simple endpoint data from clinical assays often used in diagnostic practice or clinical trials; may include repeated measures and a treatment/intervention context. Examples include bloodwork results (creatine assay, serum antibody assay), tumor size measurements, or medication adherence. Note that clinical data are from human individuals, therefore species should be “human”. ",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,comments",TRUE,Sage Bionetworks,template,,,,Clinical_Assay_Template,Class,Template,Template,Assay_Template,,, -clinicalAssayTemplate_Extended,Annotation template for simple endpoint data from clinical assays often used in diagnostic practice or clinical trials; may include repeated measures and a treatment/intervention context. Extended to capture additional drug/treatment parameters.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,compoundName,compoundDose,comments",TRUE,Sage Bionetworks,template,,,,Clinical_Assay_Template_Extended,Class,Template,Template,Assay_Template,,, -behavioralAssayTemplate,"Generic template for describing data from behavioral assays such as “adaptive n-back task” (for humans) or “shock-probe defensive burying test” (for mice). If another modality is used as part of the behavioral assay, e.g. fMRI, that data can be linked.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,experimentalCondition,experimentalTimepoint,comments",TRUE,Sage Bionetworks,template,,,,Behavioral_Assay_Template,Class,Template,Template,Assay_Template,,, -sourceCodeTemplate,Template for describing scripts or source code files for a software application.,,"Component,Filename,resourceType,programmingLanguage,documentation,runtimePlatform,comments",TRUE,Sage Bionetworks,template,,,,Source_Code_Template,Class,Template,Template,Non_Assay_Template,,, -protocolTemplate,Template for describing a protocol document. (BETA) Adapted from https://bioschema.org/profiles/LabProtocol/0.6-DRAFT-2020_12_08,,"Component,Filename,resourceType,author,citation,license,comments",TRUE,Sage Bionetworks,template,,,,Protocol_Template,Class,Template,Template,Non_Assay_Template,,, -pdxGenomicsAssay,Template for describing PDX assay data that extends genomicsAssay.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,transplantationType,genePerturbed,runType,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,PDX_Genomics_Assay_Template,Class,Template,Template,Assay_Template,,, -updateMilestoneReport,Defines a metadata template for updating milestone report values in NF studies -- currently a supported feature for NTAP and GFF.,,"Component,Filename,resourceType,progressReportNumber",FALSE,Sage Bionetworks,template,,,,Update_Milestone_Report,Class,Template,Template,Non_Assay_Template,,, -template,Parent attribute for the manifest template attributes.,,,FALSE,Sage Bionetworks,template,,,,Template,Class,Template,Template,,,, -individualTemplate,Base template for minimal information describing individual-level data within the NF scope. Not called “patientTemplate_Default” because individuals can be a non-human organism.,"individualID,sex,age,ageUnit,species,diagnosis,nf1Genotype,nf2Genotype","Component,individualID,sex,age,ageUnit,species,diagnosis,nf1Genotype,nf2Genotype",FALSE,Sage Bionetworks,template,,,,Individual_Template,Class,Template,Template,Non_Assay_Template,,, -biospecimenTemplate_Normalized,Base template for describing biospecimen-level data.,"parentSpecimenID,specimenID,aliquotID,organ,tissue,isCellLine,isPrimaryCell,cellType,tumorType,specimenPreparationMethod,modelSystemName","Component,parentSpecimenID,specimenID,aliquotID,organ,tissue,isCellLine,isPrimaryCell,cellType,tumorType,specimenPreparationMethod,modelSystemName",FALSE,Sage Bionetworks,template,,,,Biospecimen_Template_Normalized,Class,Template,Template,Non_Assay_Template,,, -biospecimenTemplate,Denormalized template for describing biospecimen data that includes all individual-level data as well.,,"Component,individualID,parentSpecimenID",FALSE,Sage Bionetworks,template,,,,Biospecimen_Template,Class,Template,Template,Non_Assay_Template,,, -dataFileComponent,Template component for describing a data file resource that extends fileTemplate_Default with required properties dataType and dataSubtype.,"Filename,entityId,fileFormat,resourceType,dataType,dataSubtype","Filename,entityId,fileFormat,resourceType,dataType,dataSubtype",FALSE,Sage Bionetworks,template,,,,Data_File_Component,Class,Template,TemplateComponent,,,, -experimentComponent,Template component for describing core experimental parameters.,"experimentalCondition,experimentalTimepoint","experimentalCondition,experimentalTimepoint",FALSE,Sage Bionetworks,template,,,,Experiment_Component,Class,Template,TemplateComponent,,,, -genePerturbComponent,Template component for adding genetic perturbation metadata. This applies only to some assays and does not make sense with e.g. behavioral assays.,"genePerturbed,genePerturbationType,genePerturbationTechnology","genePerturbed,genePerturbationType,genePerturbationTechnology",FALSE,Sage Bionetworks,template,,,,Gene_Perturb_Component,Class,Template,TemplateComponent,,,, -fileComponent,Template component for describing some file on the NF-OSI Synapse platform.,"Filename,entityId,fileFormat,resourceType","Filename,entityId,fileFormat,resourceType",FALSE,Sage Bionetworks,template,,,,File_Component,Class,Template,TemplateComponent,,,, +Attribute,Description,Valid Values,DependsOn,Required,Source,Parent,Properties,DependsOn Component,Validation Rules,.ID,.Type,.Module,.Root,.SubOf,.Range,.Cardinality,.EditorNote +genomicsAssayTemplate_Normalized,"Generic template for describing raw data from a genomic type assay (RNA-seq, Exome-seq, etc) WITHOUT full individual and biospecimen data. To link individual and biospecimen metadata, an additional “biospecimenTemplate_Default” must be additionally completed with either specimenID or aliquotID available for joining. This is a two-step template.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,specimenID,aliquotID,runType,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,Genomics_Assay_Template_Normalized,Class,Template,Template,Assay_Template,,, +genomicsAssayTemplate,"Generic denormalized template for describing raw data from a genomic type assay (RNA-seq, Exome-seq, etc) along with individual, biospecimen and experimental metadata. This is a one-step template.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,runType,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,Genomics_Assay_Template,Class,Template,Template,Assay_Template,,, +genomicsAssayTemplate_Extended,"Template for describing raw data from a genomic type assay (RNA-seq, Exome-seq, etc) with extended properties for capturing additional metadata such as gene perturbation parameters or experimental conditions and time points. This is a one-step template.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,runType,libraryPrep,genePerturbed,comments",TRUE,Sage Bionetworks,template,,,,Genomics_Assay_Template_Extended,Class,Template,Template,Assay_Template,,, +WGSTemplate,"Template for describing raw data from Whole Genome Sequencing (WGS)",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,runType,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,WGS_Template,Class,Template,Template,Assay_Template,,, +WESTemplate,"Template for describing raw data from Whole Exome Sequencing (WES)",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,runType,targetCaptureKitID,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,WES_Template,Class,Template,Template,Assay_Template,,, +RNASeqTemplate,"Template for describing raw data from (bulk) RNA-sequencing",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,runType,libraryPrep,targetDepth,comments",TRUE,Sage Bionetworks,template,,,,RNA_Seq_Template,Class,Template,Template,Assay_Template,,, +ScRNASeqTemplate,"Template for describing raw data from single-cell RNA-sequencing (scRNA-seq)",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,runType,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,ScRNA_Seq_Template,Class,Template,Template,Assay_Template,,, +ProcessedAlignedReadsTemplate,"Template for describing aligned reads output data (i.e. BAM)",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,averageInsertSize,averageReadLength,averageBaseQuality,pairsOnDifferentChr,readsDuplicatedPercent,readsMappedPercent,meanCoverage,proportionCoverage10x,proportionCoverage30x,readDepth,totalReads,workflow,genomicReference,comments",TRUE,Sage Bionetworks,template,,,,Processed_Aligned_Reads_Template,Class,Template,Template,Assay_Template,,, +ProcessedVariantCallsTemplate,"Template for describing either germline or variant calls output data (i.e. VCF/MAF)",,"Component,Filename,resourceType,progressReportNumber,specimenID,dataType,assay,individualID,workflow,comments",TRUE,Sage Bionetworks,template,,,,Processed_Variant_Calls_Template,Class,Template,Template,Assay_Template,,, +ProcessedExpressionTemplate,"Template for describing expression output data",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,individualID,specimenID,workflow,expressionUnit,comments",TRUE,Sage Bionetworks,template,,,,Processed_Expression_Template,Class,Template,Template,Assay_Template,,, +imagingAssayTemplate,"Generic template for describing data from an imaging type assay (IHC, etc). This is a one-step template.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,assay,platformTarget,individualID,parentSpecimenID,comments",TRUE,Sage Bionetworks,template,,,,Imaging_Assay_Template,Class,Template,Template,Assay_Template,,, +imagingAssayTemplate_Extended,"Template for describing data from an imaging type assay (IHC, etc) with extended properties for capturing additional metadata such as gene perturbation parameters or experimental conditions and time points. This is a one-step template.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,assay,platformTarget,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,genePerturbed,comments",TRUE,Sage Bionetworks,template,,,,Imaging_Assay_Template_Extended,Class,Template,Template,Assay_Template,,, +MRIAssayTemplate,Generic template for describing data from an MRI assay. This is a one-step template.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,MRISequence,comments",TRUE,Sage Bionetworks,template,,,,MRI_Assay_Template,Class,Template,Template,Assay_Template,,, +epigeneticsAssayTemplate,Generic template for describing data from an epigenetics assay. This is a one-step template.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,Epigenetics_Assay_Template,Class,Template,Template,Assay_Template,,, +pharmacokineticsAssayTemplate,Generic template for describing data from a pharmacokinetics assay. This is a one-step template.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,assay,platformTarget,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,genePerturbed,comments",TRUE,Sage Bionetworks,template,,,,Pharmacokinetics_Assay_Template,Class,Template,Template,Assay_Template,,, +proteomicsAssayTemplate,Generic template for describing data from a proteomics assay. Note that specialized proteomics assays may have their own template to capture more detailed information. This is a one-step template.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,proteinExtractSource,comments ",TRUE,Sage Bionetworks,template,,,,Proteomics_Assay_Template,Class,Template,Template,Assay_Template,,, +plateBasedReporterAssayTemplate,Generic template for describing data from a plate-based reporter assay. This is a one-step template.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,assay,platformTarget,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,reporterGene,reporterSubstance,comments",TRUE,Sage Bionetworks,template,,,,Plate_Based_Reporter_Assay_Template,Class,Template,Template,Assay_Template,,, +patientTimepointsTemplate,Template for capturing individual-level metadata with time points. Do not use for data file annotation.,,"Component,individualID,experimentalTimepoint",TRUE,Sage Bionetworks,template,,,,Patient_Timepoints_Template,Class,Template,Template,Non_Assay_Template,,, +clinicalAssayTemplate,"Annotation template for simple endpoint data from clinical assays often used in diagnostic practice or clinical trials; may include repeated measures and a treatment/intervention context. Examples include bloodwork results (creatine assay, serum antibody assay), tumor size measurements, or medication adherence. Note that clinical data are from human individuals, therefore species should be “human”. ",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,comments",TRUE,Sage Bionetworks,template,,,,Clinical_Assay_Template,Class,Template,Template,Assay_Template,,, +clinicalAssayTemplate_Extended,Annotation template for simple endpoint data from clinical assays often used in diagnostic practice or clinical trials; may include repeated measures and a treatment/intervention context. Extended to capture additional drug/treatment parameters.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,compoundName,compoundDose,comments",TRUE,Sage Bionetworks,template,,,,Clinical_Assay_Template_Extended,Class,Template,Template,Assay_Template,,, +behavioralAssayTemplate,"Generic template for describing data from behavioral assays such as “adaptive n-back task” (for humans) or “shock-probe defensive burying test” (for mice). If another modality is used as part of the behavioral assay, e.g. fMRI, that data can be linked.",,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,experimentalCondition,experimentalTimepoint,comments",TRUE,Sage Bionetworks,template,,,,Behavioral_Assay_Template,Class,Template,Template,Assay_Template,,, +sourceCodeTemplate,Template for describing scripts or source code files for a software application.,,"Component,Filename,resourceType,programmingLanguage,documentation,runtimePlatform,comments",TRUE,Sage Bionetworks,template,,,,Source_Code_Template,Class,Template,Template,Non_Assay_Template,,, +protocolTemplate,Template for describing a protocol document. (BETA) Adapted from https://bioschema.org/profiles/LabProtocol/0.6-DRAFT-2020_12_08,,"Component,Filename,resourceType,author,citation,license,comments",TRUE,Sage Bionetworks,template,,,,Protocol_Template,Class,Template,Template,Non_Assay_Template,,, +pdxGenomicsAssay,Template for describing PDX assay data that extends genomicsAssay.,,"Component,Filename,resourceType,progressReportNumber,dataType,assay,platform,individualID,parentSpecimenID,experimentalCondition,experimentalTimepoint,transplantationType,genePerturbed,runType,libraryPrep,comments",TRUE,Sage Bionetworks,template,,,,PDX_Genomics_Assay_Template,Class,Template,Template,Assay_Template,,, +updateMilestoneReport,Defines a metadata template for updating milestone report values in NF studies -- currently a supported feature for NTAP and GFF.,,"Component,Filename,resourceType,progressReportNumber",FALSE,Sage Bionetworks,template,,,,Update_Milestone_Report,Class,Template,Template,Non_Assay_Template,,, +template,Parent attribute for the manifest template attributes.,,,FALSE,Sage Bionetworks,template,,,,Template,Class,Template,Template,,,, +individualTemplate,Base template for minimal information describing individual-level data within the NF scope. Not called “patientTemplate_Default” because individuals can be a non-human organism.,"individualID,sex,age,ageUnit,species,diagnosis,nf1Genotype,nf2Genotype","Component,individualID,sex,age,ageUnit,species,diagnosis,nf1Genotype,nf2Genotype",FALSE,Sage Bionetworks,template,,,,Individual_Template,Class,Template,Template,Non_Assay_Template,,, +biospecimenTemplate_Normalized,Base template for describing biospecimen-level data.,"parentSpecimenID,specimenID,aliquotID,organ,tissue,isCellLine,isPrimaryCell,cellType,tumorType,specimenPreparationMethod,modelSystemName","Component,parentSpecimenID,specimenID,aliquotID,organ,tissue,isCellLine,isPrimaryCell,cellType,tumorType,specimenPreparationMethod,modelSystemName",FALSE,Sage Bionetworks,template,,,,Biospecimen_Template_Normalized,Class,Template,Template,Non_Assay_Template,,, +biospecimenTemplate,Denormalized template for describing biospecimen data that includes all individual-level data as well.,,"Component,individualID,parentSpecimenID",FALSE,Sage Bionetworks,template,,,,Biospecimen_Template,Class,Template,Template,Non_Assay_Template,,, +dataFileComponent,Template component for describing a data file resource that extends fileTemplate_Default with required properties dataType and dataSubtype.,"Filename,entityId,fileFormat,resourceType,dataType,dataSubtype","Filename,entityId,fileFormat,resourceType,dataType,dataSubtype",FALSE,Sage Bionetworks,template,,,,Data_File_Component,Class,Template,TemplateComponent,,,, +experimentComponent,Template component for describing core experimental parameters.,"experimentalCondition,experimentalTimepoint","experimentalCondition,experimentalTimepoint",FALSE,Sage Bionetworks,template,,,,Experiment_Component,Class,Template,TemplateComponent,,,, +genePerturbComponent,Template component for adding genetic perturbation metadata. This applies only to some assays and does not make sense with e.g. behavioral assays.,"genePerturbed,genePerturbationType,genePerturbationTechnology","genePerturbed,genePerturbationType,genePerturbationTechnology",FALSE,Sage Bionetworks,template,,,,Gene_Perturb_Component,Class,Template,TemplateComponent,,,, +fileComponent,Template component for describing some file on the NF-OSI Synapse platform.,"Filename,entityId,fileFormat,resourceType","Filename,entityId,fileFormat,resourceType",FALSE,Sage Bionetworks,template,,,,File_Component,Class,Template,TemplateComponent,,,, ngsComponent,Template component capturing Next Gen Sequencing/genomics attributes.,"runType,readPair,isStranded,readPairOrientation,readStrandOrigin,libraryPrep,libraryPreparationMethod,dissociationMethod,readLength,nucleicAcidSource","runType,readPair,isStranded,readPairOrientation,readStrandOrigin,libraryPrep,libraryPreparationMethod,dissociationMethod,readLength,nucleicAcidSource",FALSE,Sage Bionetworks,template,,,,NGS_Component,Class,Template,TemplateComponent,,,, \ No newline at end of file