Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposition trial use #227

Merged
merged 5 commits into from
Nov 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ imports:
$defs:
CohortAlleleFrequencyStudyResult:
inherits: va-core:StudyResult
maturity: draft
maturity: trial use
type: object
description: >-
A StudyResult that reports measures related to the frequency of an Allele in a cohort
Expand Down
51 changes: 0 additions & 51 deletions schema/va-spec/base/def/Characteristic.rst

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. warning:: This data class is at a **draft** maturity level and may \
change significantly in future releases. Maturity \
.. note:: This data class is at a **trial use** maturity level and may \
change in future releases. Maturity \
levels are described in the :ref:`maturity-model`.

**Computational Definition**
Expand Down
5 changes: 1 addition & 4 deletions schema/va-spec/base/def/DataSet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,8 @@ Some DataSet attributes are inherited from :ref:`gks-core:Entity`.
- A specific type of data set the DataSet instance represents (e.g. a 'clinical data set', a 'sequencing data set', a 'gene expression data set', a 'genome annotation data set')
* - reportedIn
-
.. raw:: html

<span style="background-color: #B2DFEE; color: black; padding: 2px 6px; border: 1px solid black; border-radius: 3px; font-weight: bold; display: inline-block; margin-bottom: 5px;" title="Unordered">&#8942;</span>
- :ref:`Document` | :ref:`iriReference`
- 0..m
- 0..1
- A document in which the the Method is reported.
* - releaseDate
-
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. warning:: This data class is at a **draft** maturity level and may \
change significantly in future releases. Maturity \
.. note:: This data class is at a **trial use** maturity level and may \
change in future releases. Maturity \
levels are described in the :ref:`maturity-model`.

**Computational Definition**
Expand Down Expand Up @@ -66,7 +66,7 @@ Some ExperimentalVariantFunctionalImpactProposition attributes are inherited fro
-
- string
- 1..1
- The relationship this Proposition describes between the subject Variant and object Sequence Feature whose function it may alter.
- The relationship this Proposition describes between the subject variant and object sequence feature whose function it may alter.
* - objectSequenceFeature
-
- :ref:`iriReference` | :ref:`MappableConcept`
Expand Down
8 changes: 1 addition & 7 deletions schema/va-spec/base/def/Method.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,17 +59,11 @@ Some Method attributes are inherited from :ref:`gks-core:Entity`.
- MUST be "Method".
* - subtype
-
.. raw:: html

<span style="background-color: #D3D3D3; color: black; padding: 2px 6px; border: 1px solid black; border-radius: 3px; font-weight: bold; display: inline-block; margin-bottom: 5px;" title="Draft Maturity Level">D</span>
- :ref:`MappableConcept`
- 0..1
- A specific type of method that a Method instance represents (e.g. 'Variant Interpretation Guideline', or 'Experimental Protocol').
* - reportedIn
-
.. raw:: html

<span style="background-color: #B2DFEE; color: black; padding: 2px 6px; border: 1px solid black; border-radius: 3px; font-weight: bold; display: inline-block; margin-bottom: 5px;" title="Unordered">&#8942;</span>
- :ref:`Document` | :ref:`iriReference`
- 0..m
- 0..1
- A document in which the the Method is reported.
17 changes: 6 additions & 11 deletions schema/va-spec/base/def/StudyGroup.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. warning:: This data class is at a **draft** maturity level and may \
change significantly in future releases. Maturity \
.. note:: This data class is at a **trial use** maturity level and may \
change in future releases. Maturity \
levels are described in the :ref:`maturity-model`.

**Computational Definition**
Expand Down Expand Up @@ -59,22 +59,17 @@ Some StudyGroup attributes are inherited from :ref:`gks-core:Entity`.
- Must be "StudyGroup"
* - memberCount
-
.. raw:: html

<span style="background-color: #D3D3D3; color: black; padding: 2px 6px; border: 1px solid black; border-radius: 3px; font-weight: bold; display: inline-block; margin-bottom: 5px;" title="Draft Maturity Level">D</span>
- integer
- 0..1
- The total number of individual members in the StudyGroup.
* - isSubsetOf
-
.. raw:: html

<span style="background-color: #B2DFEE; color: black; padding: 2px 6px; border: 1px solid black; border-radius: 3px; font-weight: bold; display: inline-block; margin-bottom: 5px;" title="Unordered">&#8942;</span>
- :ref:`StudyGroup`
- 0..m
- A larger StudyGroup of which this StudyGroup represents a subset.
* - characteristics
-
.. raw:: html

<span style="background-color: #B2DFEE; color: black; padding: 2px 6px; border: 1px solid black; border-radius: 3px; font-weight: bold; display: inline-block; margin-bottom: 5px;" title="Unordered">&#8942;</span>
- :ref:`Characteristic`
- :ref:`MappableConcept`
- 0..m
- A feature or role shared by all members of the StudyGroup, representing a criterion for membership in the group.
42 changes: 0 additions & 42 deletions schema/va-spec/base/json/Characteristic

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://w3id.org/ga4gh/schema/va-spec/1.x/base/json/CohortAlleleFrequencyStudyResult",
"title": "CohortAlleleFrequencyStudyResult",
"maturity": "draft",
"maturity": "trial use",
"type": "object",
"description": "A StudyResult that reports measures related to the frequency of an Allele in a cohort",
"properties": {
Expand Down
20 changes: 8 additions & 12 deletions schema/va-spec/base/json/DataSet
Original file line number Diff line number Diff line change
Expand Up @@ -51,18 +51,14 @@
"description": "A specific type of data set the DataSet instance represents (e.g. a 'clinical data set', a 'sequencing data set', a 'gene expression data set', a 'genome annotation data set')"
},
"reportedIn": {
"type": "array",
"ordered": false,
"items": {
"oneOf": [
{
"$ref": "/ga4gh/schema/va-spec/1.x/base/json/Document"
},
{
"$ref": "/ga4gh/schema/gks-core/1.x/json/iriReference"
}
]
},
"oneOf": [
{
"$ref": "/ga4gh/schema/va-spec/1.x/base/json/Document"
},
{
"$ref": "/ga4gh/schema/gks-core/1.x/json/iriReference"
}
],
"description": "A document in which the the Method is reported."
},
"releaseDate": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://w3id.org/ga4gh/schema/va-spec/1.x/base/json/ExperimentalVariantFunctionalImpactProposition",
"title": "ExperimentalVariantFunctionalImpactProposition",
"maturity": "draft",
"maturity": "trial use",
"type": "object",
"description": "A proposition reporting a conclusion from a single assay or study about the functional impact of a variant on a sequence feature (typically a gene or gene product).",
"properties": {
Expand Down Expand Up @@ -60,9 +60,9 @@
},
"predicate": {
"type": "string",
"description": "The relationship this Proposition describes between the subject Variant and object Sequence Feature whose function it may alter.",
"description": "The relationship this Proposition describes between the subject variant and object sequence feature whose function it may alter.",
"$comment": "When applied to represent a particular type of Proposition (via 'Profiling'), implementers can define a value set of predicates for the relationships relevant in the domain.",
"const": "impactsFunctionOf"
"default": "impactsFunctionOf"
},
"objectSequenceFeature": {
"oneOf": [
Expand Down
25 changes: 10 additions & 15 deletions schema/va-spec/base/json/Method
Original file line number Diff line number Diff line change
Expand Up @@ -46,23 +46,18 @@
},
"subtype": {
"$ref": "/ga4gh/schema/gks-core/1.x/json/MappableConcept",
"maturity": "draft",
"$comment": "This attribute can be used to report a specific type for the Method, in cases where a model does not define Method subclasses for this purpose. Implementers can define their own set of method type codes/terms, to match the needs of their application.\n reportedIn:",
"description": "A specific type of method that a Method instance represents (e.g. 'Variant Interpretation Guideline', or 'Experimental Protocol')."
"description": "A specific type of method that a Method instance represents (e.g. 'Variant Interpretation Guideline', or 'Experimental Protocol').",
"$comment": "This attribute can be used to report a specific type for the Method, in cases where a model does not define Method subclasses for this purpose. Implementers can define their own set of method type codes/terms, to match the needs of their application."
},
"reportedIn": {
"type": "array",
"ordered": false,
"items": {
"oneOf": [
{
"$ref": "/ga4gh/schema/va-spec/1.x/base/json/Document"
},
{
"$ref": "/ga4gh/schema/gks-core/1.x/json/iriReference"
}
]
},
"oneOf": [
{
"$ref": "/ga4gh/schema/va-spec/1.x/base/json/Document"
},
{
"$ref": "/ga4gh/schema/gks-core/1.x/json/iriReference"
}
],
"description": "A document in which the the Method is reported."
}
},
Expand Down
17 changes: 6 additions & 11 deletions schema/va-spec/base/json/StudyGroup
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"$id": "https://w3id.org/ga4gh/schema/va-spec/1.x/base/json/StudyGroup",
"title": "StudyGroup",
"type": "object",
"maturity": "draft",
"maturity": "trial use",
"description": "A collection of individuals or specimens from the same taxonomic class, selected for analysis in a scientific study based on their exhibiting one or more common characteristics (e.g. species, race, age, gender, disease state, income). May be referred to as a 'cohort' or 'population' in specific research settings.",
"$comment": "A Study Group may include all participants in a given study, or specific subsets that are designated based on shared roles or characteristics.",
"properties": {
Expand Down Expand Up @@ -45,24 +45,19 @@
"default": "StudyGroup"
},
"memberCount": {
"maturity": "draft",
"$comment": "this is draft until we see utility in real-world datasets",
"type": "integer",
"description": "The total number of individual members in the StudyGroup."
},
"isSubsetOf": {
"type": "array",
"items": {
"$ref": "/ga4gh/schema/va-spec/1.x/base/json/StudyGroup"
},
"ordered": false,
"description": "A larger StudyGroup of which this StudyGroup represents a subset."
},
"characteristics": {
"type": "array",
"items": {
"$ref": "/ga4gh/schema/va-spec/1.x/base/json/Characteristic"
"$ref": "/ga4gh/schema/gks-core/1.x/json/MappableConcept"
},
"ordered": false,
"description": "A feature or role shared by all members of the StudyGroup, representing a criterion for membership in the group."
"description": "A feature or role shared by all members of the StudyGroup, representing a criterion for membership in the group.",
"$comment": "We should evaluate this for use with boolean operators before going normative"
}
},
"required": [
Expand Down
Loading