Sequence Assays

WGS

Related files:

🔬 Background doc: More details about this type.
📝 Excel template: For metadata entry.
📝 TSV template: Alternative for metadata entry.

Metadata schema

Version 1 (use this one)

Shared by all types

version
description
donor_id
tissue_id
execution_datetime
protocols_io_doi
operator
operator_email
pi
pi_email
assay_category
assay_type
analyte_class
is_targeted
acquisition_instrument_vendor
acquisition_instrument_model

Unique to this type

gdna_fragmentation_quality_assurance
dna_assay_input_value
dna_assay_input_unit
library_construction_method
library_construction_protocols_io_doi
library_layout
library_adapter_sequence
library_final_yield
library_final_yield_unit
library_average_fragment_size
sequencing_reagent_kit
sequencing_read_format
sequencing_read_percent_q30
sequencing_phix_percent
contributors_path
data_path

Shared by all types

`version`

Version of the schema to use when validating this metadata.

constraint	value
enum	`1`
required	`True`

`description`

Free-text description of this assay.

constraint	value
required	`True`

`donor_id`

HuBMAP Display ID of the donor of the assayed tissue. Example: ABC123.

constraint	value
pattern (regular expression)	`[A-Z]+[0-9]+`
required	`True`

`tissue_id`

HuBMAP Display ID of the assayed tissue. Example: ABC123-BL-1-2-3_456.

constraint	value
pattern (regular expression)	`(([A-Z]+[0-9]+)-[A-Z]{2}\d(-\d+)+(_\d+)?)(,([A-Z]+[0-9]+)-[A-Z]{2}\d(-\d+)+(_\d+)?)*`
required	`True`

Start date and time of assay, typically a date-time stamped folder generated by the acquisition instrument. YYYY-MM-DD hh:mm, where YYYY is the year, MM is the month with leading 0s, and DD is the day with leading 0s, hh is the hour with leading zeros, mm are the minutes with leading zeros.

constraint	value
type	`datetime`
format	`%Y-%m-%d %H:%M`
required	`True`

`protocols_io_doi`

DOI for protocols.io referring to the protocol for this assay.

constraint	value
required	`True`
pattern (regular expression)	`10\.17504/.*`
url	prefix: `https://dx.doi.org/`

`operator`

Name of the person responsible for executing the assay.

constraint	value
required	`True`

`operator_email`

Email address for the operator.

constraint	value
format	`email`
required	`True`

`pi`

Name of the principal investigator responsible for the data.

constraint	value
required	`True`

`pi_email`

Email address for the principal investigator.

constraint	value
format	`email`
required	`True`

`assay_category`

Each assay is placed into one of the following 4 general categories: generation of images of microscopic entities, identification & quantitation of molecules by mass spectrometry, imaging mass spectrometry, and determination of nucleotide sequence.

constraint	value
enum	`sequence`
required	`True`

`assay_type`

The specific type of assay being executed.

constraint	value
enum	`WGS`
required	`True`

`analyte_class`

Analytes are the target molecules being measured with the assay.

constraint	value
enum	`DNA`
required	`True`

`is_targeted`

Specifies whether or not a specific molecule(s) is/are targeted for detection/measurement by the assay.

constraint	value
type	`boolean`
required	`True`

`acquisition_instrument_vendor`

An acquisition instrument is the device that contains the signal detection hardware and signal processing software. Assays generate signals such as light of various intensities or color or signals representing the molecular mass.

constraint	value
required	`True`

`acquisition_instrument_model`

Manufacturers of an acquisition instrument may offer various versions (models) of that instrument with different features or sensitivities. Differences in features or sensitivities may be relevant to processing or interpretation of the data.

constraint	value
required	`True`

Unique to this type

`gdna_fragmentation_quality_assurance`

Is the gDNA integrity good enough for WGS? This is usually checked through running a gel.

constraint	value
enum	`Pass` or `Fail`
required	`True`

`dna_assay_input_value`

Amount of DNA input into library preparation.

constraint	value
type	`number`
required	`True`

`dna_assay_input_unit`

Units of DNA input into library preparation. Leave blank if not applicable.

constraint	value
enum	`ug`
required	`False`
required if	`dna_assay_input_value` present

`library_construction_method`

Describes DNA library preparation kit. Modality of isolating gDNA, Fragmentation and generating sequencing libraries.

constraint	value
required	`True`

`library_construction_protocols_io_doi`

A link to the protocol document containing the library construction method (including version) that was used.

constraint	value
required	`True`
pattern (regular expression)	`10\.17504/.*`
url	prefix: `https://dx.doi.org/`

`library_layout`

State whether the library was generated for single-end or paired end sequencing.

constraint	value
enum	`single-end` or `paired-end`
required	`True`

`library_adapter_sequence`

The adapter sequence to be used for adapter trimming starting with the 5’ end. (eg. 5-ATCCTGAGAA) Example: 5-AATGATACGGCGACCACCGAGATCTACACTCTTTCCCTACACGACGCTCTTCCGATCT.

constraint	value
pattern (regular expression)	`5-[GATCU]+`
required	`True`

`library_final_yield`

Total amount of library after final pcr amplification step.

constraint	value
type	`number`
required	`True`

`library_final_yield_unit`

Total units of library after final pcr amplification step. Leave blank if not applicable.

constraint	value
enum	`ng`
required	`False`
required if	`library_final_yield` present

`library_average_fragment_size`

Average size in basepairs (bp) of sequencing library fragments estimated via gel electrophoresis or bioanalyzer/tapestation.

constraint	value
type	`integer`
required	`True`

`sequencing_reagent_kit`

Reagent kit used for sequencing.

constraint	value
required	`True`

`sequencing_read_format`

Slash-delimited list of the number of sequencing cycles for, for example, Read1, i7 index, i5 index, and Read2. Example: 12/34/56.

constraint	value
pattern (regular expression)	`\d+(/\d+)+`
required	`True`

`sequencing_read_percent_q30`

Q30 is the weighted average of all the reads (e.g. # bases UMI * q30 UMI + # bases R2 * q30 R2 + …)

constraint	value
type	`number`
required	`True`
minimum	`0`
maximum	`100`

`sequencing_phix_percent`

Percent PhiX loaded to the run.

constraint	value
type	`number`
required	`True`
minimum	`0`
maximum	`100`

`contributors_path`

Relative path to file with ORCID IDs for contributors for this dataset.

constraint	value
required	`True`

`data_path`

Relative path to file or directory with instrument data. Downstream processing will depend on filename extension conventions.

constraint	value
required	`True`

Version 0