Skip to content

Commit

Permalink
Prepare release v 3.0.0 (#17)
Browse files Browse the repository at this point in the history
* Update README.md

* rename field mappings file; update readme
  • Loading branch information
cimendes authored Dec 14, 2021
1 parent 6436980 commit d3c7c25
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ In the face of the current SARS-CoV-2 pandemic, [PHA4GE](https://pha4ge.org) has

Public health genomics contextual data includes sample metadata, lab/clinical/epidemiological data, and analysis methods information. Contextual data enables the interpretation of the sequence data, informs decision making for public health responses, and facilitates scientific understanding of infectious disease. Structured and consistent contextual data can also be more easily processed, aggregated, and reused by both humans and computers for different types of analyses.

The SARS-CoV-2 contextual data specification includes a metadata collection template, reference guide, controlled vocabulary, and mapping to existing standards. We also provide a suite of protocols for submitting sequence data and contextual data to public repositories, enabling global interoperability of the data. The specification and all of the supporting materials are freely available and detailed below.
The SARS-CoV-2 contextual data specification includes a metadata collection template, reference guides, controlled vocabulary, and mapping to existing standards. We also provide a suite of protocols for submitting sequence data and contextual data to public repositories, enabling global interoperability of the data. The specification and all of the supporting materials are freely available and detailed below.

## Content description

Expand All @@ -49,11 +49,11 @@ It contains the following items (tabs in the spreadsheet):

The collection template contains "required" (colour-coded yellow), "strongly recommended" (colour-coded purple) and "optional" (colour-coded white) fields.

1. **guidance for populating the template;**
2. **guidance for populating the template;**

The reference guide aims to facilitate the use of the collection template. It contains field definitions, further guidance/instructions, and examples of structured data. Mapping of PHA4GE fields to existing metadata standards such as the Sample Application Standard, MIxS v 5.0, and the MIGS Virus Host-associated package can be found in the reference guide.
The reference guide aims to facilitate the use of the collection template. It contains field definitions, further guidance/instructions, and examples of structured data.

1. **ontology-mapped controlled vocabulary for the picklists.**
3. **ontology-mapped controlled vocabulary for the picklists.**

Lists of controlled vocabulary, agreed upon by PHA4GE, are provided here for populating the template.

Expand All @@ -68,14 +68,19 @@ This SOP provides users with step-by-step instructions for populating the templa

### Supporting materials

#### [PHA4GE to sequence repository field mappings](PHA4GE%20to%20Sequence%20Repository%20Field%20Mappings.xlsx)
#### [PHA4GE to WHO and sequence repository field mappings](PHA4GE%20to%20WHO%20and%20Sequence%20Repository%20Field%20Mappings.xlsx)

**WHO recommended contextual data mapping to PHA4GE fields**

PHA4GE fields are mapped to corresponding contextual data elements recommended by the World Health Organization (World Health Organization. Guidance for surveillance of SARS-CoV-2 variants: interim guidance. WHO/2019-nCoV/surveillance/variants2021.1).

**PHA4GE to sequence repository field mappings**

A **mapping file** indicating which PHA4GE fields correspond to which fields within the different repository submission forms is provided to facilitate data transformations for submissions. Field mappings to the following repositories are available in the document:

- GISAID
- ENA
- NCBI
- WHO

#### Submission protocols

Expand Down

0 comments on commit d3c7c25

Please sign in to comment.