Skip to content

Commit f2e5c4f

Browse files
committed
add missing links
1 parent 309eb13 commit f2e5c4f

File tree

1 file changed

+26
-17
lines changed

1 file changed

+26
-17
lines changed

Diff for: README.md

+26-17
Original file line numberDiff line numberDiff line change
@@ -30,39 +30,45 @@ supporting materials are freely available in this repository.
3030
**Table 1:** Resources that form the PHA4GE SARS-CoV-2 contextual data specification package available in this repository.
3131
| File Name | Resource | Description | |
3232
|- |- |- |- |
33-
| [PHA4GE SARS-CoV-2 Contextual Data Template.xlsx](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SARS-CoV-2%20Contextual%20Data%20Template%202.1.xlsx) | Collection template and controlled vocabulary pick lists | Spreadsheet-based collection form containing different fields (identifiers and accessions, sample collection and processing, sequencing, host information, host exposure information, bioinformatics and QC metrics, author acknowledgements). Fields are colour-coded to indicate required, recommended or optional status. Many fields offer pick lists of controlled vocabulary. Vocabulary lists are also available in a separate tab. | |
34-
| [PHA4GE SARS-CoV-2 Contextual Data Template.xlsx](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SARS-CoV-2%20Contextual%20Data%20Template%202.1.xlsx) | Reference guide | Field definitions, guidance, and examples are provided as a separate tab in the collection template .xlsx file. | |
35-
| [PHA4GE Contextual Data SOP.docx](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20Contextual%20Data%20SOP%201.0.docx) | Collection template SOP | Step-by-step instructions for using the collection template are provided in the SOP. Ethical, practical, and privacy considerations are also discussed. Examples and instructions for structuring sample descriptions as well as sourcing additional standardized terms (outside those provided in pick lists) are also discussed. | |
36-
| [PHA4GE SARS-CoV-2 Contextual Data Template.xlsx](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SARS-CoV-2%20Contextual%20Data%20Template%202.1.xlsx) | PHA4GE fields to metadata standards mapping | PHA4GE fields are mapped to existing metadata standards such as the [Sample Application Standard](https://www.niaid.nih.gov/research/human-pathogen-and-vector-sequencing-metadata-standards), [MIxS 5.0](https://gensc.org/mixs/), and the [MIGS Virus Host-associated attribute package](https://www.ncbi.nlm.nih.gov/biosample/docs/packages/MIGS.eu.host-associated.5.0/). Mappings are available in the Reference guide tab. Mappings highlight which fields of these standards are considered useful for SARS-CoV-2 public health surveillance and investigations, and which fields are considered not applicable. | |
37-
| [PHA4GE to Sequence Repository Field Mappings.xlsx](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20to%20Sequence%20Repository%20Field%20Mappings%201.0.xlsx) | ENA, NCBI and GISAID submission requirements to PHA4GE field mappings | Many PHA4GE fields have been sourced from public repository submission requirements. The different repositories have different requirements and field names. Repository submission fields have been mapped to PHA4GE fields to demonstrate equivalencies and divergences. | |
33+
| [PHA4GE SARS-CoV-2 Contextual Data Template.xlsx](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SARS-CoV-2%20Contextual%20Data%20Template.xlsx) | Collection template and controlled vocabulary pick lists | Spreadsheet-based collection form containing different fields (identifiers and accessions, sample collection and processing, sequencing, host information, host exposure information, bioinformatics and QC metrics, author acknowledgements). Fields are colour-coded to indicate required, recommended or optional status. Many fields offer pick lists of controlled vocabulary. Vocabulary lists are also available in a separate tab. | |
34+
| [PHA4GE SARS-CoV-2 Contextual Data Template.xlsx](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SARS-CoV-2%20Contextual%20Data%20Template.xlsx) | Reference guide | Field definitions, guidance, and examples are provided as a separate tab in the collection template .xlsx file. | |
35+
| [PHA4GE Contextual Data SOP.docx](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20Contextual%20Data%20SOP.docx) | Collection template SOP | Step-by-step instructions for using the collection template are provided in the SOP. Ethical, practical, and privacy considerations are also discussed. Examples and instructions for structuring sample descriptions as well as sourcing additional standardized terms (outside those provided in pick lists) are also discussed. | |
36+
| [PHA4GE SARS-CoV-2 Contextual Data Template.xlsx](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SARS-CoV-2%20Contextual%20Data%20Template.xlsx) | PHA4GE fields to metadata standards mapping | PHA4GE fields are mapped to existing metadata standards such as the [Sample Application Standard](https://www.niaid.nih.gov/research/human-pathogen-and-vector-sequencing-metadata-standards), [MIxS 5.0](https://gensc.org/mixs/), and the [MIGS Virus Host-associated attribute package](https://www.ncbi.nlm.nih.gov/biosample/docs/packages/MIGS.eu.host-associated.5.0/). Mappings are available in the Reference guide tab. Mappings highlight which fields of these standards are considered useful for SARS-CoV-2 public health surveillance and investigations, and which fields are considered not applicable. | |
37+
| [PHA4GE to Sequence Repository Field Mappings.xlsx](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20to%20Sequence%20Repository%20Field%20Mappings.xlsx) | ENA, NCBI and GISAID submission requirements to PHA4GE field mappings | Many PHA4GE fields have been sourced from public repository submission requirements. The different repositories have different requirements and field names. Repository submission fields have been mapped to PHA4GE fields to demonstrate equivalencies and divergences. | |
3838
| [PHA4GE SARS-CoV-2 NCBI submission protocol- SRA, BioSample, and BioProject.pdf](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SARS-CoV-2%20NCBI%20submission%20protocol-%20SRA%2C%20BioSample%2C%20and%20BioProject.pdf), [SARS-CoV-2 NCBI assembly submission protocol: GenBank.pdf](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SARS-CoV-2%20NCBI%20assembly%20submission%20protocol-%20GenBank.pdf) and [PHA4GE SOP for populating NCBI submission templates for SARS-CoV-2 (BioSample, SRA, and GenBank).pdf](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SOP%20for%20populating%20NCBI%20submission%20templates%20for%20SARS-CoV-2%20(BioSample%2C%20SRA%2C%20and%20GenBank).pdf) | Data submission protocol (NCBI) | The SARS-CoV-2 submission protocol for NCBI provides step-by-step instructions and recommendations aimed at improving interoperability and consistency of submitted data. | |
39-
| [PHA4GE SARS-CoV-2 EBI submission protocol- ENA, BioSample, and BioProject.pdf](), [PHA4GE SARS-CoV-2 EBI assembly submission protocol.pdf]() and [PHA4GE SOP for populating EBI submission templates (ENA).pdf]() | Data submission protocol (ENA) | The SARS-CoV-2 submission protocol for ENA provides step-by-step instructions and recommendations aimed at improving interoperability and consistency of submitted data. | |
39+
| [PHA4GE SARS-CoV-2 EBI submission protocol- ENA, BioSample, and BioProject.pdf](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SARS-CoV-2%20EBI%20submission%20protocol-%20ENA%2C%20BioSample%2C%20and%20BioProject.pdf), [PHA4GE SARS-CoV-2 EBI assembly submission protocol.pdf](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SARS-CoV-2%20EBI%20assembly%20submission%20protocol.pdf) and [PHA4GE SOP for populating EBI submission templates (ENA).pdf](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SOP%20for%20populating%20EBI%20submission%20templates%20(ENA).pdf) | Data submission protocol (ENA) | The SARS-CoV-2 submission protocol for ENA provides step-by-step instructions and recommendations aimed at improving interoperability and consistency of submitted data. | |
4040
| [PHA4GE SARS-CoV-2 GISAID Submission Protocol](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SARS-CoV-2%20GISAID%20Submission%20Protocol.pdf) | Data submission protocol (GISAID) | The SARS-CoV-2 submission protocol for GISAID provides step-by-step instructions and recommendations aimed at improving interoperability and consistency of submitted data. | |
4141
| [PHA4GE SARS-CoV-2 Standardised Terms.csv](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SARS-CoV-2%20Standardised%20Terms.csv) and [PHA4GE_SARS-CoV-2_Contextual_Data_Schema.json](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE_SARS-CoV-2_Contextual_Data_Schema.json) | JSON structure of PHA4GE specification | A JSON structure of the PHA4GE specification has been provided for easier integration into software applications. Originated from the standardised terms csv file. | |
4242

4343
### Collection template and controlled vocabulary pick lists
44-
The PHA4GE SARS-CoV-2 Contextual data Collection Template can be used for data management, and consists a
45-
spreadsheet-based (.xlsx) collection template, a reference guide, and a controlled vocabulary list. This information
46-
does not have to be shared, but sharing with public repositories is encouraged when permitted.
44+
The [PHA4GE SARS-CoV-2 Contextual data Collection Template](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SARS-CoV-2%20Contextual%20Data%20Template.xlsx)
45+
can be used for data management, and consists a spreadsheet-based (.xlsx) collection template, a reference guide, and a
46+
controlled vocabulary list. This information does not have to be shared, but sharing with public repositories is
47+
encouraged when permitted.
4748

4849
Fields are grouped according to whether they describe sampling, host information (symptoms, exposures etc), sequencing,
4950
bioinformatics and quality control metrics, etc. The collection template contains "required" (colour-coded yellow),
5051
"strongly recommended" (colour-coded purple) and "optional" (colour-coded white) fields. In many fields, picklists of
5152
ontology-mapped controlled vocabulary are offered to better standardize data values.
5253

5354
### Reference guide
54-
To facilitate the use of the collection template, a reference guide with field definitions, further
55-
guidance/instructions, and examples of structured data is available.
55+
Available in the The [PHA4GE SARS-CoV-2 Contextual data Collection Template](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SARS-CoV-2%20Contextual%20Data%20Template.xlsx),
56+
the reference guide aims to facilitate the use of the collection template. It contains field definitions, further
57+
guidance/instructions, and examples of structured data.
5658

5759
### Collection template SOP
58-
A Standard Operating Procedure (SOP) containing instructions for using the collection template.
60+
A [Standard Operating Procedure (SOP)](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20Contextual%20Data%20SOP.docx) containing instructions for using the collection template.
5961

6062
The template SOP provides users with step-by-step instructions for populating the template, looking up standardized
6163
terms, and how best to structure sample descriptions. The SOP also highlights a number of ethical, practical, and
6264
privacy considerations for data sharing.
6365

6466
### PHA4GE fields to metadata standards mapping
65-
Minimum information checklists are community standards that describe attributes of genomes in a standardized way. There are several existing standards that are useful for structuring SARS-CoV-2 contextual data. The PHA4GE SARS-CoV-2 specification implements these standards, and maps to standardized fields where applicable. Mapping of PHA4GE fields to the Sample Application Standard, MIxS v 5.0, and the MIGS Virus Host-associated package can be found in the reference guide.
67+
Minimum information checklists are community standards that describe attributes of genomes in a standardized way.
68+
There are several existing standards that are useful for structuring SARS-CoV-2 contextual data.
69+
The PHA4GE SARS-CoV-2 specification implements these standards, and maps to standardized fields where applicable.
70+
Mapping of PHA4GE fields to the Sample Application Standard, MIxS v 5.0, and the MIGS Virus Host-associated package can
71+
be found in the [reference guide](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SARS-CoV-2%20Contextual%20Data%20Template.xlsx).
6672

6773

6874
### ENA, NCBI and GISAID submission requirements to PHA4GE field mappings
@@ -91,11 +97,11 @@ The NCBI data submission process is covered by three separate protocols:
9197
### Data submission protocol (ENA)
9298
The data submission process is split into three separate protocols.
9399

94-
* [PHA4GE SOP for populating the three templates for SARS-CoV-2 submission to EBI]()
100+
* [PHA4GE SOP for populating the three templates for SARS-CoV-2 submission to EBI](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SOP%20for%20populating%20EBI%20submission%20templates%20(ENA).pdf)
95101
* **The protocol is available in protocols.io under the DOI [dx.doi.org/10.17504/protocols.io.bh5dj826](https://dx.doi.org/10.17504/protocols.io.bh5dj826).**
96-
* [PHA4GE SARS-CoV-2 EBI submission protocol for Biosamples and seqeuence read data]()
102+
* [PHA4GE SARS-CoV-2 EBI submission protocol for Biosamples and seqeuence read data](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SARS-CoV-2%20EBI%20submission%20protocol-%20ENA%2C%20BioSample%2C%20and%20BioProject.pdf)
97103
* **The protocol is available in protocols.io under the DOI [dx.doi.org/10.17504/protocols.io.bhwdj7a6](https://dx.doi.org/10.17504/protocols.io.bhwdj7a6).**
98-
* [PHA4GE SARS-CoV-2 EBI submission protocol for genome assemblies]()
104+
* [PHA4GE SARS-CoV-2 EBI submission protocol for genome assemblies](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SARS-CoV-2%20EBI%20assembly%20submission%20protocol.pdf)
99105
* **The protocol is available in protocols.io under the DOI [dx.doi.org/10.17504/protocols.io.bhwqj7dw](https://dx.doi.org/10.17504/protocols.io.bhwqj7dw).**
100106

101107
### Data submission protocol (GISAID)
@@ -110,7 +116,10 @@ limitation, it deviates slightly from the collection template where the "require
110116
set as required and both the "strongly recommended" (colour-coded purple) and "optional" (colour-coded white) fields
111117
are both set as option.
112118

113-
The JSON is produced automatically from the [csv version](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SARS-CoV-2%20Standardised%20Terms.csv) of the template using the [this](https://github.com/pha4ge/SARS-CoV-2-Data-Spec-JSON) script.
119+
The [JSON](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE_SARS-CoV-2_Contextual_Data_Schema.json)
120+
is produced automatically from the [csv version](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SARS-CoV-2%20Standardised%20Terms.csv)
121+
of the template using the the script available from [SARS-CoV-2-Data-Spec-JSON](https://github.com/pha4ge/SARS-CoV-2-Data-Spec-JSON)
122+
repository.
114123

115124
**Table 2** Terms for SARS-CoV-2 submission template according to the PHA4GE contextual data collection specification in
116125
[PHA4GE SARS-CoV-2 Standardised Terms](https://github.com/pha4ge/SARS-CoV-2-Contextual-Data-Specification/blob/master/PHA4GE%20SARS-CoV-2%20Standardised%20Terms.csv)

0 commit comments

Comments
 (0)