Skip to content

Commit

Permalink
wokring on quantity variance
Browse files Browse the repository at this point in the history
  • Loading branch information
DanielPuthawala committed Mar 27, 2024
1 parent 7dae574 commit bf20353
Show file tree
Hide file tree
Showing 5 changed files with 92 additions and 53 deletions.
103 changes: 52 additions & 51 deletions schema/catvrs/catvrs-source.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -174,63 +174,14 @@ $defs:
required:
- label

# QuantityChange:
# maturity: draft
# type: object
# inherits: CategoricalVariation
# description: >-
# The Quantity Change class captures one axis of variation in the generalized model of categorical
# variation. It is used to model quantitative measure changes in a given biological level of
# variation.
# properties:
# type:
# type: string
# const: QuantityChange
# default: QuantityChange
# description: 'MUST be "QuantityChange"'
# label:
# extends: label
# description: >-
# A primary label for the categorical variation. This required property should provide a
# short and descriptive textual representation of the concept.
# description:
# extends: description
# description: >-
# A textual description of the domain of variation that should match the categorical
# variation entity.
# locationMatchCharacteristic:
# type: string
# enum: ['exact', 'partial', 'subinterval', 'superinterval']
# description: >-
# The characteristics of a valid match between a contextual CNV location (the query) and the
# Categorical CNV location (the domain), when both query and domain are represented on the same
# reference sequence. An `exact` match requires the location of the query and domain to be identical.
# A `subinterval` match requires the query to be a subinterval of the domain. A `superinterval` match
# requires the query to be a superinterval of the domain. A `partial` match requires at least 1 residue
# of overlap between the query and domain.
# copyChange:
# type: string
# enum: [ "efo:0030069", "efo:0020073", "efo:0030068", "efo:0030067", "efo:0030064", "efo:0030070", "efo:0030071", "efo:0030072" ]
# description: >-
# A representation of the change in copies of a sequence in a system. MUST be one of "efo:0030069" (complete
# genomic loss), "efo:0020073" (high-level loss), "efo:0030068" (low-level loss), "efo:0030067" (loss),
# "efo:0030064" (regional base ploidy), "efo:0030070" (gain), "efo:0030071" (low-level gain), "efo:0030072"
# (high-level gain).
# copies:
# oneOf:
# - type: integer
# - $refCurie: vrs:Range
# description: >-
# The integral number of copies of the subject in a system.
# required:
# - label

NumberCount:
maturity: draft
# ga4ghDigest:
# keys:
# - numberCount
type: object
# inherits: QuantityVariance
description: >-
The absolute count of a discrete assayable unit (e.g. chromosome, gene, or sequence).
properties:
Expand All @@ -245,7 +196,7 @@ $defs:
- type: integer
- $refCurie: vrs:Range
description: >-
The integral quantity or wuantity range of the subject in a system
The integral quantity or quantity range of the subject in a system
required: [ "count" ]


Expand Down Expand Up @@ -281,6 +232,56 @@ $defs:
"efo:0030070" (gain), "efo:0030071" (low-level gain), "efo:0030072" (high-level gain).
required: [ "change" ]

QuantityVariance:
maturity: draft
type: object
inherits: NumberCount
description: >-
The Quantity Variance class captures one axis of variation in the generalized model of categorical
variation. It is used to model quantitative measure changes in a given biological level of
variation.
properties:
type:
type: string
const: QuantityVariance
default: QuantityVariance
description: 'MUST be "QuantityVariance"'
# label:
# extends: label
# description: >-
# A primary label for the quantity variant. This required property should provide a
# short and descriptive textual representation of the concept.
# description:
# extends: description
# description: >-
# A textual description of the domain of variation that should match the categorical
# variation entity.
# locationMatchCharacteristic:
# type: string
# enum: ['exact', 'partial', 'subinterval', 'superinterval']
# description: >-
# The characteristics of a valid match between a contextual CNV location (the query) and the
# Categorical CNV location (the domain), when both query and domain are represented on the same
# reference sequence. An `exact` match requires the location of the query and domain to be identical.
# A `subinterval` match requires the query to be a subinterval of the domain. A `superinterval` match
# requires the query to be a superinterval of the domain. A `partial` match requires at least 1 residue
# of overlap between the query and domain.
# copyChange:
# type: string
# enum: [ "efo:0030069", "efo:0020073", "efo:0030068", "efo:0030067", "efo:0030064", "efo:0030070", "efo:0030071", "efo:0030072" ]
# description: >-
# A representation of the change in copies of a sequence in a system. MUST be one of "efo:0030069" (complete
# genomic loss), "efo:0020073" (high-level loss), "efo:0030068" (low-level loss), "efo:0030067" (loss),
# "efo:0030064" (regional base ploidy), "efo:0030070" (gain), "efo:0030071" (low-level gain), "efo:0030072"
# (high-level gain).
# copies:
# oneOf:
# - type: integer
# - $refCurie: vrs:Range
# description: >-
# The integral number of copies of the subject in a system.
# required:
# - label


# # Categorical Variation is presented top-down. Everything rolls up to
Expand Down
2 changes: 1 addition & 1 deletion schema/catvrs/def/NumberCount.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ The absolute count of a discrete assayable unit (e.g. chromosome, gene, or seque
* - count
- integer | `Range <../vrs/vrs.yaml#/$defs/Range>`_
- 1..1
- The integral quantity or wuantity range of the subject in a system
- The integral quantity or quantity range of the subject in a system
20 changes: 20 additions & 0 deletions schema/catvrs/def/QuantityVariance.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
**Computational Definition**

The Quantity Variance class captures one axis of variation in the generalized model of categorical variation. It is used to model quantitative measure changes in a given biological level of variation.

**Information Model**

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

* - Field
- Type
- Limits
- Description
* - type
- string
- 0..1
- MUST be "QuantityVariance"
2 changes: 1 addition & 1 deletion schema/catvrs/json/NumberCount
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"type": "integer"
}
],
"description": "The integral quantity or wuantity range of the subject in a system"
"description": "The integral quantity or quantity range of the subject in a system"
}
},
"required": [
Expand Down
18 changes: 18 additions & 0 deletions schema/catvrs/json/QuantityVariance
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://w3id.org/ga4gh/schema/catvrs/1.x/json/QuantityVariance",
"title": "QuantityVariance",
"type": "object",
"maturity": "draft",
"description": "The Quantity Variance class captures one axis of variation in the generalized model of categorical variation. It is used to model quantitative measure changes in a given biological level of variation.",
"properties": {
"type": {
"type": "string",
"const": "QuantityVariance",
"default": "QuantityVariance",
"description": "MUST be \"QuantityVariance\""
}
},
"required": [],
"additionalProperties": false
}

0 comments on commit bf20353

Please sign in to comment.