Skip to content

Commit

Permalink
data dictionary update (#25)
Browse files Browse the repository at this point in the history
* data dictionary update

* updated sample and biospecimen description

* individual description updates
  • Loading branch information
mauerk authored Sep 6, 2024
1 parent 3da36fb commit 882f4ad
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 13 deletions.
Empty file modified scripts/update_metadata_docs.py
100644 → 100755
Empty file.
8 changes: 4 additions & 4 deletions user_docs/metadata/data_dictionary/Individual.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,19 +35,19 @@ An Individual is a Person who is participating in a Study.
///

### ***geographical_region_term***
**description** : The geographical region where the Individual is located.<br>
**description** : The geographical region where the Individual is located. The Geographical Region is captured using a concept from the NCIT "country" class (NCIT:C25464) (e.g., Austria, Germany, Italy).<br>
**required** : False<br>
**data type** : string <br>
### ***geographical_region_id***
**description** : The geographical region where the Individual is located.<br>
**description** : The corresponding ID to the NCIT vocabulary (e.g., NCIT:C16312, NCIT:C16636, NCIT:C16761).<br>
**required** : False<br>
**data type** : string <br>
### ***ancestry_terms***
**description** : A person's descent or lineage from a population.<br>
**description** : A person's descent or lineage from a population. The Ancestry is captured using a concept from the Human Ancestry Ontology "ancestry category" (HANCESTRO:0004) branch (e.g., African, European, Oceanian).<br>
**required** : False<br>
**data type** : string <br>
### ***ancestry_ids***
**description** : A person's descent or lineage from a population.<br>
**description** : The corresponding ID to the HANCESTRO vocabulary (e.g., HANCESTRO:0010, HANCESTRO:0005, HANCESTRO:0017).<br>
**required** : False<br>
**data type** : string <br>
### ***alias***
Expand Down
4 changes: 2 additions & 2 deletions user_docs/metadata/data_dictionary/Sample.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,11 +150,11 @@ A Sample is a limited quantity of something to be used for testing, analysis, in

### ***biospecimen_tissue_term***
**description** : The tissue this Biospecimen originated from. Should be a term from the BRENDA Tissue Ontology vocabulary (e.g., kidney, blood, melanoma cell).<br>
**required** : True<br>
**required** : False<br>
**data type** : string <br>
### ***biospecimen_tissue_id***
**description** : The corresponding ontology ID for the biospecimen_tissue_term (e.g., BTO:0000671, BTO:0000089, BTO:0000848).<br>
**required** : True<br>
**required** : False<br>
**data type** : string <br>
### ***biospecimen_isolation***
**description** : Method or device employed for collecting/isolating this Biospecimen.<br>
Expand Down
12 changes: 5 additions & 7 deletions user_docs/metadata/entities.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,19 +25,17 @@ If the data submitters have additional information to provide about the *Individ
#### **Individual Supporting File metadata properties**
The **Individual Supporting File** requires the following information: file format, file name, dataset associated with this file as well as if the file is included as part of the submission.

### **Biospecimen/Sample**
### **Sample**

The *Biospecimen/Sample* describes the extracted sample and tissue for an experimental process. Furthermore, a *Sample* is defined as a limited quantity of something to be used for testing, analysis, inspection, investigation, demonstration, or trial use. A sample is prepared from a biospecimen (isolate or tissue).
The *Sample* describes the extracted sample and tissue for an experimental process. Furthermore, the *Sample* is defined as a limited quantity of something to be used for testing, analysis, inspection, investigation, demonstration, or trial use. A sample is prepared from a biospecimen (isolate or tissue). The *Sample* entity includes slots describing the *Biospecimen* from which the sample was prepared, which are highlighted with a "*biospecimen_*" -prefix. The *Biospecimen* is defined as any natural material taken from a biological entity for testing, diagnostics, treatment or research purposes.

A *Biospecimen* is defined in GHGAs metadata as any natural material taken from a biological entity for testing, diagnostics, treatment or research purposes. The *Biospecimen* is linked to the *Individual* entity from which the biospecimen itself has been derived.
The *Sample* is linked to the *Individual* entity describing the collection of biological material. Further, it is linked to the *Experiment*.

The *Biospecimen/Sample* is linked to the *Individual* entity describing the collection of biological material. Further, it is linked to the *Experiment*.

#### **Biospecimen/Sample metadata properties**
#### **Sample metadata properties**

The *Sample* entity requires data submitters to provide the name, description, whether the sample is case or control, as well as the alias to the *Individual* from which the *Sample* was derived. In addition to the mandatory information, the data submitter is recommended to provide information about the storage, whether the sample can be classified as diseased or healthy, and biological replicate information. Other optional fields include the type of the sample and an EGA accession ID.

The *Biospecimen* entity requires data submitters to provide information about the age of the individual at the time of sampling and the biospecimen tissue. The recommended properties include a name for the biospecimen, its type, the vital status of the individual at the time of sampling, and the biospecimen isolation and storage.
To further describe the *Biospecimen* from which the sample was prepared, data submitters are required to provide information about the age of the individual at the time of sampling and the biospecimen tissue. The recommended properties include a name for the biospecimen, its type, the vital status of the individual at the time of sampling, and the biospecimen isolation and storage.

### **Experiment**

Expand Down

0 comments on commit 882f4ad

Please sign in to comment.