Skip to content

Commit

Permalink
first stab
Browse files Browse the repository at this point in the history
  • Loading branch information
Mrinal-Thomas-Epic committed Oct 9, 2024
1 parent 03c4631 commit f570aa1
Show file tree
Hide file tree
Showing 7 changed files with 531 additions and 49 deletions.
3 changes: 3 additions & 0 deletions schema/profiles/def/ConsequenceTerm.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
**Computational Definition**

Types of effects of a variant on a downstream molecule
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
**Computational Definition**

A Statement describing the role of a variant in causing an inherited condition.
A statement describing the effect of a variant on a downstream molecule.

**Information Model**

Some VariantPathogenicityStatement attributes are inherited from :ref:`gks.core-im:Statement`.
Some MolecularConsequenceStatement attributes are inherited from :ref:`gks.core-im:Statement`.

.. list-table::
:class: clean-wrap
Expand Down Expand Up @@ -60,6 +60,10 @@ Some VariantPathogenicityStatement attributes are inherited from :ref:`gks.core-
- :ref:`RecordMetadata`
- 0..1
- Provenance metadata about a specific concrete record of information as encoded/serialized in a particular data set or object (as opposed to provenance about the abstract information content the encoding carries).
* - object
- object
- 1..1
- An Entity or concept that is related to the subject of a Statement via its predicate.
* - direction
- string
- 0..1
Expand Down Expand Up @@ -87,7 +91,7 @@ Some VariantPathogenicityStatement attributes are inherited from :ref:`gks.core-
* - type
- string
- 1..1
- MUST be "VariantPathogenicityStatement".
- MUST be "MolecularConsequenceStatement".
* - subjectVariant
- :ref:`Variation` | :ref:`CategoricalVariant` | :ref:`IRI`
- 1..1
Expand All @@ -96,19 +100,19 @@ Some VariantPathogenicityStatement attributes are inherited from :ref:`gks.core-
- string
- 1..1
- The relationship declared to hold between the subject and the object of the Statement.
* - objectCondition
- :ref:`Condition` | :ref:`IRI`
* - objectMolecule
- :ref:`SequenceReference` | :ref:`IRI`
- 1..1
- The :ref:`Condition` for which the variant impact is stated.
* - penetranceQualifier
- string
- 0..1
- Reports the penetrance of the pathogenic effect - i.e. the extent to which the variant impact is expressed by individuals carrying it as a measure of the proportion of carriers exhibiting the condition.
* - modeOfInheritanceQualifier
- :ref:`Coding`
- 0..m
- Reports a pattern of inheritance expected for the pathogenic effect of the variant. Use HPO terms within the hierarchy of 'HP:0000005' (mode of inheritance) to specify.
* - geneContextQualifier
- The molecule affected by the variant (cDNA reference sequence preferred).
* - geneQualifier
- :ref:`Gene` | :ref:`IRI`
- 0..1
- Reports the gene through which the pathogenic effect asserted for the variant is mediated (i.e. it is the variant's impact on this gene that is responsible for causing the condition).
- The gene affected by the variant.
* - consequenceTermsQualifier
- :ref:`ConsequenceTerm`
- 1..m
- Terms describing the effect of the variant on the molecule
* - molecularChangeQualifier
- :ref:`Allele` | :ref:`Expression`
- 0..m
- The sequence change caused by the variant on the downstream transcript or protein reference sequence.
102 changes: 102 additions & 0 deletions schema/profiles/def/ToolPredictedEffectStatement.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
**Computational Definition**

A prediction about a variant made by a tool

**Information Model**

Some ToolPredictedEffectStatement attributes are inherited from :ref:`gks.core-im:Statement`.

.. list-table::
:class: clean-wrap
:header-rows: 1
:align: left
:widths: auto

* - Field
- Type
- Limits
- Description
* - id
- string
- 0..1
- The 'logical' identifier of the Entity in the system of record, e.g. a UUID. This 'id' is unique within a given system, but may or may not be globally unique outside the system. It is used within a system to reference an object from another.
* - label
- string
- 0..1
- A primary name for the entity.
* - description
- string
- 0..1
- A free-text description of the Entity.
* - alternativeLabels
- string
- 0..m
- Alternative name(s) for the Entity.
* - extensions
- :ref:`Extension`
- 0..m
- A list of extensions to the Entity, that allow for capture of information not directly supported by elements defined in the model.
* - specifiedBy
- :ref:`Method` | :ref:`IRI`
- 0..1
- A specification that describes all or part of the process that led to creation of the Information Entity
* - contributions
- :ref:`Contribution`
- 0..m
- Specific actions taken by an Agent toward the creation, modification, validation, or deprecation of an Information Entity.
* - reportedIn
- :ref:`Document` | :ref:`IRI`
- 0..m
- A document in which the the Information Entity is reported.
* - dateAuthored
- string
- 0..1
- Indicates when the information content expressed in the Information Entity was generated.
* - derivedFrom
- :ref:`InformationEntity`
- 0..m
- Another Information Entity from which this Information Entity is derived, in whole or in part.
* - recordMetadata
- :ref:`RecordMetadata`
- 0..1
- Provenance metadata about a specific concrete record of information as encoded/serialized in a particular data set or object (as opposed to provenance about the abstract information content the encoding carries).
* - subject
- object
- 1..1
- The Entity about which the Statement is made.
* - predicate
- string
- 1..1
- The relationship declared to hold between the subject and the object of the Statement.
* - object
- object
- 1..1
- An Entity or concept that is related to the subject of a Statement via its predicate.
* - direction
- string
- 0..1
- A term indicating whether the Statement supports, disputes, or remains neutral w.r.t. the validity of the Proposition it evaluates.
* - strength
- :ref:`Coding` | :ref:`IRI`
- 0..1
- A term used to report the strength of a Proposition's assessment in the direction indicated (i.e. how strongly supported or disputed the Proposition is believed to be). Implementers may choose to frame a strength assessment in terms of how *confident* an agent is that the Proposition is true or false, or in terms of the *strength of all evidence* they believe supports or disputes it.
* - score
- number
- 0..1
- A quantitative score that indicates the strength of a Proposition's assessment in the direction indicated (i.e. how strongly supported or disputed the Proposition is believed to be). Depending on its implementation, a score may reflect how *confident* that agent is that the Proposition is true or false, or the *strength of evidence* they believe supports or disputes it.
* - statementText
- string
- 0..1
- A natural-language expression of what a Statement asserts to be true.
* - classification
- :ref:`Coding` | :ref:`IRI`
- 0..1
- A single term or phrase summarizing the outcome of direction and strength assessments of a Statement's proposition, in terms of a classification of its subject.
* - hasEvidenceLines
- :ref:`EvidenceLine`
- 0..m
- An evidence-based argument that supports or disputes the validity of the proposition that a Statement assesses or puts forth as true. The strength and direction of this argument (whether it supports or disputes the proposition, and how strongly) is based on an interpretation of one or more pieces of information as evidence (i.e. 'Evidence Items).
* - type
- string
- 1..1
- MUST be "ToolPredictedEffectStatement".
51 changes: 51 additions & 0 deletions schema/profiles/json/ConsequenceTerm
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://w3id.org/ga4gh/schema/va-spec/1.x/profiles/json/ConsequenceTerm",
"title": "ConsequenceTerm",
"description": "Types of effects of a variant on a downstream molecule",
"type": "string",
"maturity": "draft",
"oneOf": [
"TranscriptAblation",
"SpliceAcceptorVariant",
"SpliceDonorVariant",
"StopGained",
"FrameshiftVariant",
"StopLost",
"StartLost",
"TranscriptAmplification",
"FeatureElongation",
"FeatureTruncation",
"InframeInsertion",
"InframeDeletion",
"MissenseVariant",
"ProteinAlteringVariant",
"SpliceDonorFifthBaseVariant",
"SpliceRegionVariant",
"SpliceDonorRegionVariant",
"SplicePolypyrimidineTractVariant",
"IncompleteTerminalCodonVariant",
"StartRetainedVariant",
"StopRetainedVariant",
"SynonymousVariant",
"CodingSequenceVariant",
"MatureMiRNAVariant",
"FivePrimeUTRVariant",
"ThreePrimeUTRVariant",
"NonCodingTranscriptExonVariant",
"IntronVariant",
"NMDTranscriptVariant",
"NonCodingTranscriptVariant",
"CodingTranscriptVariant",
"UpstreamGeneVariant",
"DownstreamGeneVariant",
"TFBSAblation",
"TFBSAmplification",
"TFBindingSiteVariant",
"RegulatoryRegionAblation",
"RegulatoryRegionAmplification",
"RegulatoryRegionVariant",
"IntergenicVariant",
"SequenceVariant"
]
}
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://w3id.org/ga4gh/schema/va-spec/1.x/profiles/json/VariantPathogenicityStatement",
"title": "VariantPathogenicityStatement",
"type": "object",
"$id": "https://w3id.org/ga4gh/schema/va-spec/1.x/profiles/json/MolecularConsequenceStatement",
"title": "MolecularConsequenceStatement",
"maturity": "draft",
"description": "A Statement describing the role of a variant in causing an inherited condition.",
"type": "object",
"description": "A statement describing the effect of a variant on a downstream molecule.",
"properties": {
"id": {
"type": "string",
Expand Down Expand Up @@ -91,6 +91,15 @@
"description": "Provenance metadata about a specific concrete record of information as encoded/serialized in a particular data set or object (as opposed to provenance about the abstract information content the encoding carries).",
"$comment": "This attribute holds a structured RecordMetadata object, which can be used to capture when, how, and by whom a record serialization was generated or modified; what upstream resources it was derived or retrieved from; and record-level administrative information such as versioning and lifecycle status."
},
"object": {
"oneOf": [
{
"type": "object"
}
],
"description": "An Entity or concept that is related to the subject of a Statement via its predicate.",
"$comment": "The object of a Statement can be any Entity or concept that is related to the subject, e.g. for Genetic Variation subjects the object is often a disease, drug, gene, molecular consequence, functional impact on gene or protein."
},
"direction": {
"description": "A term indicating whether the Statement supports, disputes, or remains neutral w.r.t. the validity of the Proposition it evaluates.",
"$comment": "Statements put forth a Proposition that expresses some possible fact about the world, and may provide an assessment of this proposition's validity (i.e. how likely it is to be true or false based on evaluated evidence). The semantics of the Proposition are captured in the 'subject', 'predicate', 'object', and optional 'qualifier' attributes. An assessment of the Proposition's validity can be captured using 'direction', 'strength', and 'score' attributes. The 'direction' attribute is used to indicate whether the Statement's Proposition is *supported* by the agent's assessment (when evidence favors its validity), is *disputed* by the agent's assessment (when evidence argues against its validity), or remains *neutral* (when conflicting or insufficient evidence exists to assert one direction or the other). (Enumerated values = 'supports', 'disputes', 'neutral').",
Expand Down Expand Up @@ -146,9 +155,9 @@
},
"type": {
"type": "string",
"const": "VariantPathogenicityStatement",
"default": "VariantPathogenicityStatement",
"description": "MUST be \"VariantPathogenicityStatement\"."
"const": "MolecularConsequenceStatement",
"default": "MolecularConsequenceStatement",
"description": "MUST be \"MolecularConsequenceStatement\"."
},
"subjectVariant": {
"oneOf": [
Expand All @@ -169,39 +178,21 @@
"type": "string",
"description": "The relationship declared to hold between the subject and the object of the Statement.",
"$comment": "When applied to represent a particular type of Statement (via 'Profiling'), implementers can define a value set of predicates for the relationships relevant in the domain - ideally using terms from community ontologies or terminologies. For example, in a 'Variant Pathogenicity Statement' Profile, the predicate value set might include terms from the GENO ontology defining 'pathogenic for condition', 'benign for condition', and 'uncertain significance for condition' relationships (GENO:0000840, GENO:0000843, GENO:0000845).",
"const": "isCausalFor"
"const": "hasMolecularConsequenceFor"
},
"objectCondition": {
"objectMolecule": {
"description": "The molecule affected by the variant (cDNA reference sequence preferred).",
"oneOf": [
{
"$ref": "/ga4gh/schema/gks-common/1.x/data-types/json/IRI"
},
{
"$ref": "/ga4gh/schema/gks-common/1.x/domain-entities/json/Condition"
"$ref": "/ga4gh/schema/vrs/2.x/json/SequenceReference"
}
],
"description": "The Condition for which the variant impact is stated.",
"$comment": "The object of a Statement can be any Entity or concept that is related to the subject, e.g. for Genetic Variation subjects the object is often a disease, drug, gene, molecular consequence, functional impact on gene or protein."
},
"penetranceQualifier": {
"type": "string",
"enum": [
"high",
"low",
"risk allele"
],
"description": "Reports the penetrance of the pathogenic effect - i.e. the extent to which the variant impact is expressed by individuals carrying it as a measure of the proportion of carriers exhibiting the condition."
},
"modeOfInheritanceQualifier": {
"type": "array",
"ordered": false,
"items": {
"$ref": "/ga4gh/schema/gks-common/1.x/data-types/json/Coding"
},
"description": "Reports a pattern of inheritance expected for the pathogenic effect of the variant. Use HPO terms within the hierarchy of 'HP:0000005' (mode of inheritance) to specify."
]
},
"geneContextQualifier": {
"description": "Reports the gene through which the pathogenic effect asserted for the variant is mediated (i.e. it is the variant's impact on this gene that is responsible for causing the condition).",
"geneQualifier": {
"description": "The gene affected by the variant.",
"oneOf": [
{
"$ref": "/ga4gh/schema/gks-common/1.x/data-types/json/IRI"
Expand All @@ -210,10 +201,35 @@
"$ref": "/ga4gh/schema/gks-common/1.x/domain-entities/json/Gene"
}
]
},
"consequenceTermsQualifier": {
"description": "Terms describing the effect of the variant on the molecule",
"type": "array",
"ordered": false,
"minItems": 1,
"items": {
"$ref": "/ga4gh/schema/va-spec/1.x/profiles/json/ConsequenceTerm"
}
},
"molecularChangeQualifier": {
"description": "The sequence change caused by the variant on the downstream transcript or protein reference sequence.",
"type": "array",
"ordered": false,
"items": {
"oneOf": [
{
"$ref": "/ga4gh/schema/vrs/2.x/json/Allele"
},
{
"$ref": "/ga4gh/schema/vrs/2.x/json/Expression"
}
]
}
}
},
"required": [
"objectCondition",
"object",
"objectMolecule",
"predicate",
"subjectVariant",
"type"
Expand Down
Loading

0 comments on commit f570aa1

Please sign in to comment.