Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sbilge committed Oct 29, 2024
1 parent 3c4d715 commit dec3d6f
Show file tree
Hide file tree
Showing 13 changed files with 60 additions and 301 deletions.
10 changes: 5 additions & 5 deletions docs/schema_markdown/Individual.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,22 +43,22 @@ URI: [GHGA:Individual](https://w3id.org/GHGA/Individual)
* Range: [String](types/String.md)
* in subsets: (ontology)
* [Individual➞sex](Individual_sex.md) <sub>1..1</sub>
* Description: The genotypic sex of the Individual (e.g., female).
* Description: The biological sex of the Individual (e.g., female).
* Range: [IndividualSexEnum](IndividualSexEnum.md)
* [Individual➞geographical_region_term](Individual_geographical_region_term.md) <sub>0..1</sub>
* Description: The geographical region where the Individual is located.
* 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).
* Range: [String](types/String.md)
* in subsets: (ontology)
* [Individual➞geographical_region_id](Individual_geographical_region_id.md) <sub>0..1</sub>
* Description: The geographical region where the Individual is located.
* Description: The corresponding ID to the NCIT vocabulary (e.g., NCIT:C16312, NCIT:C16636, NCIT:C16761).
* Range: [String](types/String.md)
* in subsets: (ontology)
* [Individual➞ancestry_terms](Individual_ancestry_terms.md) <sub>0..\*</sub>
* Description: A person's descent or lineage from a population.
* Description: The Ancestry is captured using a concept from the Human Ancestry Ontology "ancestry category" (HANCESTRO:0004) branch (e.g., African, European, Oceanian).
* Range: [String](types/String.md)
* in subsets: (ontology)
* [Individual➞ancestry_ids](Individual_ancestry_ids.md) <sub>0..\*</sub>
* Description: A person's descent or lineage from a population.
* Description: The corresponding ID to the HANCESTRO vocabulary (e.g., HANCESTRO:0010, HANCESTRO:0005, HANCESTRO:0017).
* Range: [String](types/String.md)
* in subsets: (ontology)

Expand Down
2 changes: 1 addition & 1 deletion docs/schema_markdown/Individual_ancestry_terms.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Slot: ancestry_terms


A person's descent or lineage from a population. 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).
The Ancestry is captured using a concept from the Human Ancestry Ontology "ancestry category" (HANCESTRO:0004) branch (e.g., African, European, Oceanian).

URI: [GHGA:Individual_ancestry_terms](https://w3id.org/GHGA/Individual_ancestry_terms)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Slot: geographical_region_term


The geographical region where the Individual is located. 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).
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).

URI: [GHGA:Individual_geographical_region_term](https://w3id.org/GHGA/Individual_geographical_region_term)

Expand Down
4 changes: 2 additions & 2 deletions docs/schema_markdown/Ontology.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@ URI: [GHGA:ontology](https://w3id.org/GHGA/ontology)
* [Sample➞biospecimen_tissue_id](Sample_biospecimen_tissue_id.md)
* [Sample➞biospecimen_tissue_term](Sample_biospecimen_tissue_term.md)
* [ancestry_ids](ancestry_ids.md) - The corresponding ID to the HANCESTRO vocabulary (e.g., HANCESTRO:0010, HANCESTRO:0005, HANCESTRO:0017).
* [ancestry_terms](ancestry_terms.md) - A person's descent or lineage from a population. 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).
* [ancestry_terms](ancestry_terms.md) - The Ancestry is captured using a concept from the Human Ancestry Ontology "ancestry category" (HANCESTRO:0004) branch (e.g., African, European, Oceanian).
* [biospecimen_tissue_id](biospecimen_tissue_id.md) - The corresponding ontology ID for the biospecimen_tissue_term (e.g., BTO:0000671, BTO:0000089, BTO:0000848).
* [biospecimen_tissue_term](biospecimen_tissue_term.md) - The tissue this Biospecimen originated from. Should be a term from the BRENDA Tissue Ontology vocabulary (e.g., kidney, blood, melanoma cell).
* [diagnosis_ids](diagnosis_ids.md) - One or more diagnoses that the entity is associated with at the time of retrieval from the organism. The diagnosis is captured using a code from ICD-10 (WHO version). Please restrict the ICD code to the chapter letter and two digits for the main diagnosis (e.g., E10, C01).
* [diagnosis_terms](diagnosis_terms.md) - The ICD-10 terms corresponding to the ICD-10 codes (e.g., Type 1 diabetes mellitus, Malignant neoplasm of base of tongue).
* [geographical_region_id](geographical_region_id.md) - The corresponding ID to the NCIT vocabulary (e.g., NCIT:C16312, NCIT:C16636, NCIT:C16761).
* [geographical_region_term](geographical_region_term.md) - The geographical region where the Individual is located. 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).
* [geographical_region_term](geographical_region_term.md) - 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).
* [phenotypic_features_ids](phenotypic_features_ids.md) - The corresponding ID to the HPO vocabulary (e.g., HP:0002732, HP:0012735, HP:0002615).
* [phenotypic_features_terms](phenotypic_features_terms.md) - The phenotypic feature concepts that the entity is associated with at the time of retrieval from the organism. The Phenotypic Feature is captured using a concept from the Human Phenotype Ontology (e.g., Lymph node hypoplasia, Cough, Hypotension).

Expand Down
54 changes: 9 additions & 45 deletions docs/schema_markdown/analysis.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,22 @@

# Class: Analysis
# Slot: analysis


An Analysis is a data transformation that transforms input data to output data.
The Analysis associated with an entity.

URI: [GHGA:Analysis](https://w3id.org/GHGA/Analysis)
URI: [GHGA:analysis](https://w3id.org/GHGA/analysis)


[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Submission],[ResearchDataFile],[ProcessDataFile],[IdentifiedByAliasMixin],[AnalysisMethod],[ResearchDataFile]<research_data_files%201..*-%20[Analysis&#124;title:string;description:string%20%3F;type:string%20%3F;ega_accession:string%20%3F;alias:string],[AnalysisMethod]<analysis_method%201..1-%20[Analysis],[ProcessDataFile]-%20analysis%201..1>[Analysis],[Submission]++-%20analyses%201..*>[Analysis],[Submission]-%20analyses(i)%200..*>[Analysis],[ProcessDataFile]-%20analysis(i)%200..1>[Analysis],[Analysis]uses%20-.->[IdentifiedByAliasMixin])](https://yuml.me/diagram/nofunky;dir:TB/class/[Submission],[ResearchDataFile],[ProcessDataFile],[IdentifiedByAliasMixin],[AnalysisMethod],[ResearchDataFile]<research_data_files%201..*-%20[Analysis&#124;title:string;description:string%20%3F;type:string%20%3F;ega_accession:string%20%3F;alias:string],[AnalysisMethod]<analysis_method%201..1-%20[Analysis],[ProcessDataFile]-%20analysis%201..1>[Analysis],[Submission]++-%20analyses%201..*>[Analysis],[Submission]-%20analyses(i)%200..*>[Analysis],[ProcessDataFile]-%20analysis(i)%200..1>[Analysis],[Analysis]uses%20-.->[IdentifiedByAliasMixin])
## Domain and Range

## Uses Mixin
None &#8594; <sub>0..1</sub> [Analysis](Analysis.md)

* mixin: [IdentifiedByAliasMixin](IdentifiedByAliasMixin.md)
## Parents

## Referenced by Class

* **[ProcessDataFile](ProcessDataFile.md)** *[ProcessDataFile➞analysis](ProcessDataFile_analysis.md)* <sub>1..1</sub> **[Analysis](Analysis.md)**
* **[Submission](Submission.md)** *[Submission➞analyses](Submission_analyses.md)* <sub>1..\*</sub> **[Analysis](Analysis.md)**
* **None** *[analyses](analyses.md)* <sub>0..\*</sub> **[Analysis](Analysis.md)**
* **None** *[analysis](analysis.md)* <sub>0..1</sub> **[Analysis](Analysis.md)**
## Children

## Attributes
* [ProcessDataFile➞analysis](ProcessDataFile_analysis.md)


### Own

* [Analysis➞analysis_method](Analysis_analysis_method.md) <sub>1..1</sub>
* Description: The alias of the Analysis Method that is associated with this Analysis.
* Range: [AnalysisMethod](AnalysisMethod.md)
* [Analysis➞title](Analysis_title.md) <sub>1..1</sub>
* Description: The title that describes an entity.
* Range: [String](types/String.md)
* [Analysis➞description](Analysis_description.md) <sub>0..1</sub>
* Description: A description summarizing how this Analysis was carried out (e.g., description of computational tools, pipelines, workflows).
* Range: [String](types/String.md)
* [Analysis➞type](Analysis_type.md) <sub>0..1</sub>
* Description: The type of this Analysis.
* Range: [String](types/String.md)
* [Analysis➞ega_accession](Analysis_ega_accession.md) <sub>0..1</sub>
* Description: The EGA accession of the 'Analysis' entity (EGAZ).
* Range: [String](types/String.md)
* [Analysis➞research_data_files](Analysis_research_data_files.md) <sub>1..\*</sub>
* Description: One or more aliases of the Research Data Files that this Analysis used as input to create Process Data Files.
* Range: [ResearchDataFile](ResearchDataFile.md)

### Mixed in from IdentifiedByAliasMixin:

* [IdentifiedByAliasMixin➞alias](IdentifiedByAliasMixin_alias.md) <sub>1..1</sub>
* Description: The alias for an entity at the time of submission.
* Range: [String](types/String.md)

## Other properties

| | | |
| --- | --- | --- |
| **Aliases:** | | data analysis |
## Used by

2 changes: 1 addition & 1 deletion docs/schema_markdown/ancestry_terms.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Slot: ancestry_terms


A person's descent or lineage from a population. 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).
The Ancestry is captured using a concept from the Human Ancestry Ontology "ancestry category" (HANCESTRO:0004) branch (e.g., African, European, Oceanian).

URI: [GHGA:ancestry_terms](https://w3id.org/GHGA/ancestry_terms)

Expand Down
54 changes: 9 additions & 45 deletions docs/schema_markdown/dataset.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,22 @@

# Class: Dataset
# Slot: dataset


A Dataset is a collection of Files that is prepared for distribution and is tied to a Data Access Policy.
The Dataset associated with an entity.

URI: [GHGA:Dataset](https://w3id.org/GHGA/Dataset)
URI: [GHGA:dataset](https://w3id.org/GHGA/dataset)


[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Submission],[Study],[IdentifiedByAliasMixin],[File],[Study]<study%201..1-%20[Dataset&#124;title:string;description:string;types:string%20%2B;ega_accession:string%20%3F;alias:string],[DataAccessPolicy]<data_access_policy%201..1-%20[Dataset],[File]-%20dataset%201..1>[Dataset],[Submission]++-%20datasets%201..*>[Dataset],[File]-%20dataset(i)%200..1>[Dataset],[Submission]-%20datasets(i)%200..*>[Dataset],[Dataset]uses%20-.->[IdentifiedByAliasMixin],[DataAccessPolicy])](https://yuml.me/diagram/nofunky;dir:TB/class/[Submission],[Study],[IdentifiedByAliasMixin],[File],[Study]<study%201..1-%20[Dataset&#124;title:string;description:string;types:string%20%2B;ega_accession:string%20%3F;alias:string],[DataAccessPolicy]<data_access_policy%201..1-%20[Dataset],[File]-%20dataset%201..1>[Dataset],[Submission]++-%20datasets%201..*>[Dataset],[File]-%20dataset(i)%200..1>[Dataset],[Submission]-%20datasets(i)%200..*>[Dataset],[Dataset]uses%20-.->[IdentifiedByAliasMixin],[DataAccessPolicy])
## Domain and Range

## Uses Mixin
None &#8594; <sub>0..1</sub> [Dataset](Dataset.md)

* mixin: [IdentifiedByAliasMixin](IdentifiedByAliasMixin.md)
## Parents

## Referenced by Class

* **[File](File.md)** *[File➞dataset](File_dataset.md)* <sub>1..1</sub> **[Dataset](Dataset.md)**
* **[Submission](Submission.md)** *[Submission➞datasets](Submission_datasets.md)* <sub>1..\*</sub> **[Dataset](Dataset.md)**
* **None** *[dataset](dataset.md)* <sub>0..1</sub> **[Dataset](Dataset.md)**
* **None** *[datasets](datasets.md)* <sub>0..\*</sub> **[Dataset](Dataset.md)**
## Children

## Attributes
* [File➞dataset](File_dataset.md)


### Own

* [Dataset➞title](Dataset_title.md) <sub>1..1</sub>
* Description: A title for this Dataset.
* Range: [String](types/String.md)
* [Dataset➞description](Dataset_description.md) <sub>1..1</sub>
* Description: A description summarizing this Dataset.
* Range: [String](types/String.md)
* [Dataset➞types](Dataset_types.md) <sub>1..\*</sub>
* Description: The type of this Dataset.
* Range: [String](types/String.md)
* [Dataset➞ega_accession](Dataset_ega_accession.md) <sub>0..1</sub>
* Description: The EGA accession ID of an entity.
* Range: [String](types/String.md)
* [Dataset➞data_access_policy](Dataset_data_access_policy.md) <sub>1..1</sub>
* Description: The Data Access Policy that applies to this Dataset.
* Range: [DataAccessPolicy](DataAccessPolicy.md)
* [Dataset➞study](Dataset_study.md) <sub>1..1</sub>
* Description: The Study associated with this Dataset.
* Range: [Study](Study.md)

### Mixed in from IdentifiedByAliasMixin:

* [IdentifiedByAliasMixin➞alias](IdentifiedByAliasMixin_alias.md) <sub>1..1</sub>
* Description: The alias for an entity at the time of submission.
* Range: [String](types/String.md)

## Other properties

| | | |
| --- | --- | --- |
| **Exact Mappings:** | | SIO:000089 |
## Used by

2 changes: 1 addition & 1 deletion docs/schema_markdown/geographical_region_term.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Slot: geographical_region_term


The geographical region where the Individual is located. 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).
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).

URI: [GHGA:geographical_region_term](https://w3id.org/GHGA/geographical_region_term)

Expand Down
4 changes: 2 additions & 2 deletions docs/schema_markdown/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The submission centric metadata schema for the German Human Genome-Phenome Archi
* [Submission➞analysis_methods](Submission_analysis_methods.md) - The Analysis Methods that are part of this Submission.
* [ancestry_ids](ancestry_ids.md) - The corresponding ID to the HANCESTRO vocabulary (e.g., HANCESTRO:0010, HANCESTRO:0005, HANCESTRO:0017).
* [Individual➞ancestry_ids](Individual_ancestry_ids.md)
* [ancestry_terms](ancestry_terms.md) - A person's descent or lineage from a population. 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).
* [ancestry_terms](ancestry_terms.md) - The Ancestry is captured using a concept from the Human Ancestry Ontology "ancestry category" (HANCESTRO:0004) branch (e.g., African, European, Oceanian).
* [Individual➞ancestry_terms](Individual_ancestry_terms.md)
* [attributes](attributes.md) - Key/value pairs corresponding to an entity.
* [AttributeMixin➞attributes](AttributeMixin_attributes.md)
Expand Down Expand Up @@ -165,7 +165,7 @@ The submission centric metadata schema for the German Human Genome-Phenome Archi
* [ResearchDataFile➞format](ResearchDataFile_format.md) - The file format of the Research Data File (e.g., FASTQ, uBAM, FASTA).
* [geographical_region_id](geographical_region_id.md) - The corresponding ID to the NCIT vocabulary (e.g., NCIT:C16312, NCIT:C16636, NCIT:C16761).
* [Individual➞geographical_region_id](Individual_geographical_region_id.md)
* [geographical_region_term](geographical_region_term.md) - The geographical region where the Individual is located. 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).
* [geographical_region_term](geographical_region_term.md) - 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).
* [Individual➞geographical_region_term](Individual_geographical_region_term.md)
* [included_in_submission](included_in_submission.md) - Whether a File is included in the Submission or not.
* [File➞included_in_submission](File_included_in_submission.md)
Expand Down
Loading

0 comments on commit dec3d6f

Please sign in to comment.