Skip to content

Commit

Permalink
relink cat-vrs to vrs 2.x
Browse files Browse the repository at this point in the history
  • Loading branch information
larrybabb committed Sep 9, 2024
1 parent 59e067a commit 2774737
Show file tree
Hide file tree
Showing 12 changed files with 57 additions and 57 deletions.
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[submodule "submodules/vrs"]
path = submodules/vrs
url = https://github.com/ga4gh/vrs.git
branch = 2.x
branch = 2.x
36 changes: 18 additions & 18 deletions schema/cat-vrs/cat-vrs-source.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ $defs:
this categorical variant.
items:
oneOf:
- $ref: "/ga4gh/schema/vrs/2.0.0-ballot.2024-08.1/json/Variation"
- $ref: "/ga4gh/schema/gks-common/1.0.0-ballot.2024-08.1/data-types/json/IRI"
- $ref: "/ga4gh/schema/vrs/2.x/json/Variation"
- $ref: "/ga4gh/schema/gks-common/1.x/json/IRI"

ProteinSequenceConsequence:
type: object
Expand All @@ -49,7 +49,7 @@ $defs:
A change that occurs in a protein sequence as a result of genomic changes. Due to the degenerate nature
of the genetic code, there are often several genomic changes that can cause a protein sequence consequence.
The protein sequence consequence, like a :ref:`CanonicalAllele`, is defined by an
`Allele <https://vrs.ga4gh.org/en/2.0.0-ballot.2024-08/concepts/MolecularVariation/Allele.html#>`
`Allele <https://vrs.ga4gh.org/en/2.x/concepts/MolecularVariation/Allele.html#>`
that is representative of a collection of congruent Protein Alleles that share the same altered codon(s).
properties:
type:
Expand All @@ -59,10 +59,10 @@ $defs:
description: 'MUST be "ProteinSequenceConsequence"'
definingContext:
oneOf:
- $ref: "/ga4gh/schema/vrs/2.0.0-ballot.2024-08.1/json/Allele"
- $ref: "/ga4gh/schema/gks-common/1.0.0-ballot.2024-08.1/data-types/json/IRI"
- $ref: "/ga4gh/schema/vrs/2.x/json/Allele"
- $ref: "/ga4gh/schema/gks-common/1.x/data-types/json/IRI"
description: >-
The `Allele <https://vrs.ga4gh.org/en/2.0.0-ballot.2024-08/concepts/MolecularVariation/Allele.html#>`_
The `Allele <https://vrs.ga4gh.org/en/2.x/concepts/MolecularVariation/Allele.html#>`_
object that is congruent with (projects to the same codons) as alleles on other protein reference
sequences.
required:
Expand All @@ -72,7 +72,7 @@ $defs:
inherits: CategoricalVariation
maturity: draft
description: >-
A canonical allele is defined by an `Allele <https://vrs.ga4gh.org/en/2.0.0-ballot.2024-08/concepts/MolecularVariation/Allele.html#>`_
A canonical allele is defined by an `Allele <https://vrs.ga4gh.org/en/2.x/concepts/MolecularVariation/Allele.html#>`_
that is representative of a collection of congruent Alleles, each of which depict the same nucleic acid
change on different underlying reference sequences. Congruent representations of an Allele often exist
across different genome assemblies and associated cDNA transcript representations.
Expand All @@ -85,10 +85,10 @@ $defs:
description: 'MUST be "CanonicalAllele"'
definingContext:
oneOf:
- $ref: "/ga4gh/schema/vrs/2.0.0-ballot.2024-08.1/json/Allele"
- $ref: "/ga4gh/schema/gks-common/1.0.0-ballot.2024-08.1/data-types/json/IRI"
- $ref: "/ga4gh/schema/vrs/2.x/json/Allele"
- $ref: "/ga4gh/schema/gks-common/1.x/data-types/json/IRI"
description: >-
The `Allele <https://vrs.ga4gh.org/en/2.0.0-ballot.2024-08/concepts/MolecularVariation/Allele.html#>`_
The `Allele <https://vrs.ga4gh.org/en/2.x/concepts/MolecularVariation/Allele.html#>`_
object that is congruent with variants on alternate reference sequences.
required:
- definingContext
Expand All @@ -99,7 +99,7 @@ $defs:
maturity: draft
description: >-
A categorical variation domain is defined first by a sequence derived from a canonical `SequenceLocation
<https://vrs.ga4gh.org/en/2.0.0-ballot.2024-08/concepts/LocationAndReference/SequenceLocation.html>`_ ,
<https://vrs.ga4gh.org/en/2.x/concepts/LocationAndReference/SequenceLocation.html>`_ ,
which is representative of a collection of congruent Locations. The change or count of this sequence is
also described, either by a numeric value (e.g. "3 or more copies") or categorical representation
(e.g. "high-level gain"). Categorical CNVs may optionally be defined by rules specifying the location
Expand All @@ -112,10 +112,10 @@ $defs:
description: 'MUST be "CategoricalCnv"'
location:
oneOf:
- $ref: "/ga4gh/schema/vrs/2.0.0-ballot.2024-08.1/json/SequenceLocation"
- $ref: "/ga4gh/schema/gks-common/1.0.0-ballot.2024-08.1/data-types/json/IRI"
- $ref: "/ga4gh/schema/vrs/2.x/json/SequenceLocation"
- $ref: "/ga4gh/schema/gks-common/1.x/data-types/json/IRI"
description: >-
A `SequenceLocation <https://vrs.ga4gh.org/en/2.0.0-ballot.2024-08/concepts/LocationAndReference/SequenceLocation.html>`_
A `SequenceLocation <https://vrs.ga4gh.org/en/2.x/concepts/LocationAndReference/SequenceLocation.html>`_
object that represents a sequence derived from that location, and is congruent with locations
on alternate reference sequences.
locationMatchCharacteristic:
Expand All @@ -139,7 +139,7 @@ $defs:
copies:
oneOf:
- type: integer
- $ref: "/ga4gh/schema/vrs/2.0.0-ballot.2024-08.1/json/Range"
- $ref: "/ga4gh/schema/vrs/2.x/json/Range"
description: >-
The integral number of copies of the subject in a system.
required:
Expand Down Expand Up @@ -240,7 +240,7 @@ $defs:
count:
oneOf:
- type: integer
- $ref: "/ga4gh/schema/vrs/2.0.0-ballot.2024-08.1/json/Range"
- $ref: "/ga4gh/schema/vrs/2.x/json/Range"
description: >-
The integral quantity or quantity range of the subject in a system
required: [ "count" ]
Expand All @@ -266,7 +266,7 @@ $defs:
change:
oneOf:
- type: integer
- $ref: "/ga4gh/schema/vrs/2.0.0-ballot.2024-08.1/json/Range"
- $ref: "/ga4gh/schema/vrs/2.x/json/Range"
- copyChange:
type: string
enum: [ "EFO:0030069", "EFO:0020073", "EFO:0030068", "EFO:0030067", "EFO:0030064", "EFO:0030070",
Expand Down Expand Up @@ -323,7 +323,7 @@ $defs:
# copies:
# oneOf:
# - type: integer
# - $ref: "/ga4gh/schema/vrs/2.0.0-ballot.2024-08.1/json/Range"
# - $ref: "/ga4gh/schema/vrs/2.x/json/Range"
# description: >-
# The integral number of copies of the subject in a system.
# required:
Expand Down
4 changes: 2 additions & 2 deletions schema/cat-vrs/def/CanonicalAllele.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
**Computational Definition**

A canonical allele is defined by an `Allele <https://vrs.ga4gh.org/en/2.0.0-ballot.2024-08/concepts/MolecularVariation/Allele.html#>`_ that is representative of a collection of congruent Alleles, each of which depict the same nucleic acid change on different underlying reference sequences. Congruent representations of an Allele often exist across different genome assemblies and associated cDNA transcript representations.
A canonical allele is defined by an `Allele <https://vrs.ga4gh.org/en/2.x/concepts/MolecularVariation/Allele.html#>`_ that is representative of a collection of congruent Alleles, each of which depict the same nucleic acid change on different underlying reference sequences. Congruent representations of an Allele often exist across different genome assemblies and associated cDNA transcript representations.

**Information Model**

Expand Down Expand Up @@ -51,4 +51,4 @@ Some CanonicalAllele attributes are inherited from :ref:`CategoricalVariation`.
* - definingContext
- :ref:`Allele` | :ref:`IRI`
- 1..1
- The `Allele <https://vrs.ga4gh.org/en/2.0.0-ballot.2024-08/concepts/MolecularVariation/Allele.html#>`_ object that is congruent with variants on alternate reference sequences.
- The `Allele <https://vrs.ga4gh.org/en/2.x/concepts/MolecularVariation/Allele.html#>`_ object that is congruent with variants on alternate reference sequences.
4 changes: 2 additions & 2 deletions schema/cat-vrs/def/CategoricalCnv.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
**Computational Definition**

A categorical variation domain is defined first by a sequence derived from a canonical `SequenceLocation <https://vrs.ga4gh.org/en/2.0.0-ballot.2024-08/concepts/LocationAndReference/SequenceLocation.html>`_ , which is representative of a collection of congruent Locations. The change or count of this sequence is also described, either by a numeric value (e.g. "3 or more copies") or categorical representation (e.g. "high-level gain"). Categorical CNVs may optionally be defined by rules specifying the location match characteristics for member CNVs.
A categorical variation domain is defined first by a sequence derived from a canonical `SequenceLocation <https://vrs.ga4gh.org/en/2.x/concepts/LocationAndReference/SequenceLocation.html>`_ , which is representative of a collection of congruent Locations. The change or count of this sequence is also described, either by a numeric value (e.g. "3 or more copies") or categorical representation (e.g. "high-level gain"). Categorical CNVs may optionally be defined by rules specifying the location match characteristics for member CNVs.

**Information Model**

Expand Down Expand Up @@ -51,7 +51,7 @@ Some CategoricalCnv attributes are inherited from :ref:`CategoricalVariation`.
* - location
- :ref:`SequenceLocation` | :ref:`IRI`
- 1..1
- A `SequenceLocation <https://vrs.ga4gh.org/en/2.0.0-ballot.2024-08/concepts/LocationAndReference/SequenceLocation.html>`_ object that represents a sequence derived from that location, and is congruent with locations on alternate reference sequences.
- A `SequenceLocation <https://vrs.ga4gh.org/en/2.x/concepts/LocationAndReference/SequenceLocation.html>`_ object that represents a sequence derived from that location, and is congruent with locations on alternate reference sequences.
* - locationMatchCharacteristic
- string
- 0..1
Expand Down
4 changes: 2 additions & 2 deletions schema/cat-vrs/def/ProteinSequenceConsequence.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
**Computational Definition**

A change that occurs in a protein sequence as a result of genomic changes. Due to the degenerate nature of the genetic code, there are often several genomic changes that can cause a protein sequence consequence. The protein sequence consequence, like a :ref:`CanonicalAllele`, is defined by an `Allele <https://vrs.ga4gh.org/en/2.0.0-ballot.2024-08/concepts/MolecularVariation/Allele.html#>` that is representative of a collection of congruent Protein Alleles that share the same altered codon(s).
A change that occurs in a protein sequence as a result of genomic changes. Due to the degenerate nature of the genetic code, there are often several genomic changes that can cause a protein sequence consequence. The protein sequence consequence, like a :ref:`CanonicalAllele`, is defined by an `Allele <https://vrs.ga4gh.org/en/2.x/concepts/MolecularVariation/Allele.html#>` that is representative of a collection of congruent Protein Alleles that share the same altered codon(s).

**Information Model**

Expand Down Expand Up @@ -51,4 +51,4 @@ Some ProteinSequenceConsequence attributes are inherited from :ref:`CategoricalV
* - definingContext
- :ref:`Allele` | :ref:`IRI`
- 1..1
- The `Allele <https://vrs.ga4gh.org/en/2.0.0-ballot.2024-08/concepts/MolecularVariation/Allele.html#>`_ object that is congruent with (projects to the same codons) as alleles on other protein reference sequences.
- The `Allele <https://vrs.ga4gh.org/en/2.x/concepts/MolecularVariation/Allele.html#>`_ object that is congruent with (projects to the same codons) as alleles on other protein reference sequences.
16 changes: 8 additions & 8 deletions schema/cat-vrs/json/CanonicalAllele
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"title": "CanonicalAllele",
"type": "object",
"maturity": "draft",
"description": "A canonical allele is defined by an [Allele](https://vrs.ga4gh.org/en/2.0.0-ballot.2024-08/concepts/MolecularVariation/Allele.html#) that is representative of a collection of congruent Alleles, each of which depict the same nucleic acid change on different underlying reference sequences. Congruent representations of an Allele often exist across different genome assemblies and associated cDNA transcript representations.",
"description": "A canonical allele is defined by an [Allele](https://vrs.ga4gh.org/en/2.x/concepts/MolecularVariation/Allele.html#) that is representative of a collection of congruent Alleles, each of which depict the same nucleic acid change on different underlying reference sequences. Congruent representations of an Allele often exist across different genome assemblies and associated cDNA transcript representations.",
"properties": {
"id": {
"type": "string",
Expand All @@ -31,7 +31,7 @@
"type": "array",
"ordered": false,
"items": {
"$ref": "/ga4gh/schema/gks-common/1.0.0-ballot.2024.08.1/data-types/json/Extension"
"$ref": "/ga4gh/schema/gks-common/1.x/data-types/json/Extension"
},
"description": "A list of extensions to the Entity, that allow for capture of information not directly supported by elements defined in the model.",
"$comment": "Extension objects have a key-value data structure that allows definition of custom fields in the data itself. Extensions are not expected to be natively understood, but may be used for pre-negotiated exchange of message attributes between systems."
Expand All @@ -40,7 +40,7 @@
"type": "array",
"ordered": false,
"items": {
"$ref": "/ga4gh/schema/gks-common/1.0.0-ballot.2024.08.1/data-types/json/ConceptMapping"
"$ref": "/ga4gh/schema/gks-common/1.x/data-types/json/ConceptMapping"
},
"description": "A list of mappings to concepts in terminologies or code systems. Each mapping should include a coding and a relation."
},
Expand All @@ -51,10 +51,10 @@
"items": {
"oneOf": [
{
"$ref": "/ga4gh/schema/gks-common/1.0.0-ballot.2024.08.1/data-types/json/IRI"
"$ref": "/ga4gh/schema/gks-common/1.x/data-types/json/IRI"
},
{
"$ref": "/ga4gh/schema/vrs/2.0.0-ballot.2024-08.1/json/Variation"
"$ref": "/ga4gh/schema/vrs/2.x/json/Variation"
}
]
}
Expand All @@ -69,13 +69,13 @@
"definingContext": {
"oneOf": [
{
"$ref": "/ga4gh/schema/gks-common/1.0.0-ballot.2024.08.1/data-types/json/IRI"
"$ref": "/ga4gh/schema/gks-common/1.x/data-types/json/IRI"
},
{
"$ref": "/ga4gh/schema/vrs/2.0.0-ballot.2024-08.1/json/Allele"
"$ref": "/ga4gh/schema/vrs/2.x/json/Allele"
}
],
"description": "The [Allele](https://vrs.ga4gh.org/en/2.0.0-ballot.2024-08/concepts/MolecularVariation/Allele.html#) object that is congruent with variants on alternate reference sequences."
"description": "The [Allele](https://vrs.ga4gh.org/en/2.x/concepts/MolecularVariation/Allele.html#) object that is congruent with variants on alternate reference sequences."
}
},
"required": [
Expand Down
18 changes: 9 additions & 9 deletions schema/cat-vrs/json/CategoricalCnv
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"title": "CategoricalCnv",
"type": "object",
"maturity": "draft",
"description": "A categorical variation domain is defined first by a sequence derived from a canonical [SequenceLocation](https://vrs.ga4gh.org/en/2.0.0-ballot.2024-08/concepts/LocationAndReference/SequenceLocation.html) , which is representative of a collection of congruent Locations. The change or count of this sequence is also described, either by a numeric value (e.g. \"3 or more copies\") or categorical representation (e.g. \"high-level gain\"). Categorical CNVs may optionally be defined by rules specifying the location match characteristics for member CNVs.",
"description": "A categorical variation domain is defined first by a sequence derived from a canonical [SequenceLocation](https://vrs.ga4gh.org/en/2.x/concepts/LocationAndReference/SequenceLocation.html) , which is representative of a collection of congruent Locations. The change or count of this sequence is also described, either by a numeric value (e.g. \"3 or more copies\") or categorical representation (e.g. \"high-level gain\"). Categorical CNVs may optionally be defined by rules specifying the location match characteristics for member CNVs.",
"properties": {
"id": {
"type": "string",
Expand All @@ -31,7 +31,7 @@
"type": "array",
"ordered": false,
"items": {
"$ref": "/ga4gh/schema/gks-common/1.0.0-ballot.2024.08.1/data-types/json/Extension"
"$ref": "/ga4gh/schema/gks-common/1.x/data-types/json/Extension"
},
"description": "A list of extensions to the Entity, that allow for capture of information not directly supported by elements defined in the model.",
"$comment": "Extension objects have a key-value data structure that allows definition of custom fields in the data itself. Extensions are not expected to be natively understood, but may be used for pre-negotiated exchange of message attributes between systems."
Expand All @@ -40,7 +40,7 @@
"type": "array",
"ordered": false,
"items": {
"$ref": "/ga4gh/schema/gks-common/1.0.0-ballot.2024.08.1/data-types/json/ConceptMapping"
"$ref": "/ga4gh/schema/gks-common/1.x/data-types/json/ConceptMapping"
},
"description": "A list of mappings to concepts in terminologies or code systems. Each mapping should include a coding and a relation."
},
Expand All @@ -51,10 +51,10 @@
"items": {
"oneOf": [
{
"$ref": "/ga4gh/schema/gks-common/1.0.0-ballot.2024.08.1/data-types/json/IRI"
"$ref": "/ga4gh/schema/gks-common/1.x/data-types/json/IRI"
},
{
"$ref": "/ga4gh/schema/vrs/2.0.0-ballot.2024-08.1/json/Variation"
"$ref": "/ga4gh/schema/vrs/2.x/json/Variation"
}
]
}
Expand All @@ -69,13 +69,13 @@
"location": {
"oneOf": [
{
"$ref": "/ga4gh/schema/gks-common/1.0.0-ballot.2024.08.1/data-types/json/IRI"
"$ref": "/ga4gh/schema/gks-common/1.x/data-types/json/IRI"
},
{
"$ref": "/ga4gh/schema/vrs/2.0.0-ballot.2024-08.1/json/SequenceLocation"
"$ref": "/ga4gh/schema/vrs/2.x/json/SequenceLocation"
}
],
"description": "A [SequenceLocation](https://vrs.ga4gh.org/en/2.0.0-ballot.2024-08/concepts/LocationAndReference/SequenceLocation.html) object that represents a sequence derived from that location, and is congruent with locations on alternate reference sequences."
"description": "A [SequenceLocation](https://vrs.ga4gh.org/en/2.x/concepts/LocationAndReference/SequenceLocation.html) object that represents a sequence derived from that location, and is congruent with locations on alternate reference sequences."
},
"locationMatchCharacteristic": {
"type": "string",
Expand Down Expand Up @@ -104,7 +104,7 @@
"copies": {
"oneOf": [
{
"$ref": "/ga4gh/schema/vrs/2.0.0-ballot.2024-08.1/json/Range"
"$ref": "/ga4gh/schema/vrs/2.x/json/Range"
},
{
"type": "integer"
Expand Down
Loading

0 comments on commit 2774737

Please sign in to comment.