Skip to content

Commit

Permalink
add mm process and reorg data types
Browse files Browse the repository at this point in the history
  • Loading branch information
larrybabb committed Dec 4, 2023
1 parent 4ec56e4 commit 8668b15
Show file tree
Hide file tree
Showing 13 changed files with 1,003 additions and 1,645 deletions.
2 changes: 1 addition & 1 deletion docs/source/appendices/associating_annotations.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _associating_annotations:

Associating Annotations with VRS Objects
(Rewrite) Associating Annotations with VRS Objects
========================================

Information is never embedded within VRS objects. Instead, it is
Expand Down
17 changes: 1 addition & 16 deletions docs/source/appendices/design_decisions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -205,19 +205,4 @@ JSON`_ (not to be confused with `OLPC Canonical JSON`_).



.. _dd-not-using-external-chromosome-declarations:

Not using External Chromosome Declarations
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

In :ref:`ChromosomeLocation <chromosomelocation>`, the tuple <species,chromosome name>
refers an archetypal chromosome for the species. `WikiData
<https://www.wikidata.org/>`_ and `MeSH
<https://www.ncbi.nlm.nih.gov/mesh/>`_ provide such definitions (e.g.,
Human Chr 1 at `WikiData <https://www.wikidata.org/wiki/Q430258>`__
and `MeSH <https://meshb.nlm.nih.gov/record/ui?ui=D002878>`__) and
were considered, and rejected, for use in VRS. Both ontologies were
anticipated to increase complexity that was not justified by the
benefit to VRS. In addition, data in WikiData are crowd-sourced and
therefore potentially unstable, and the species coverage in MeSH was
insufficient for anticipated VRS uses.

71 changes: 71 additions & 0 deletions docs/source/datatypes_classes/base_types.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
VRS Type Framework
@@@@@@@@@@@@@@@@@@

The VRS Type Framework is a set of classes that can be used to create
VRS data classes that can be used to represent variation and location
data. It uses core elements of the GKS Common Framework as a foundation.

entity
value_object


.. _Location:

Location
########

As used by biologists, the precision of "location" (or "locus") varies
widely, ranging from precise start and end numerical coordinates
defining a Location, to bounded regions of a sequence, to conceptual
references to named genomic features (e.g., chromosomal bands, genes,
exons) as proxies for the Locations on an implied reference sequence.

The most common and concrete Location is a :ref:`SequenceLocation`, i.e.,
a Location based on a named sequence and an Interval on that sequence. Other
types of Location may be added based on community need.

.. include:: defs/Location.rst

**Implementation Guidance**

* Location refers to a position. Although it MAY imply a sequence,
the two concepts are not interchangeable, especially when the
location is non-specific (e.g., specified one or more ambiguous endpoints).
To represent a sequence derived from a Location, see
:ref:`SequenceExpression`.


.. _Variation:

Variation
#########

In the genetics community, variation is often used to mean *sequence*
variation, describing the differences observed in DNA or AA bases among
individuals, and typically with respect to a common reference sequence.

In VRS, the Variation class is the conceptual root of all types of biomolecular
variation, and the *Variation* abstract class is the top-level object in
the :ref:`vr-schema-diagram`. Variation types are broadly categorized as
:ref:`MolecularVariation`, :ref:`SystemicVariation`, or a :ref:`utility
subclass <utilityvariation>`. Types of variation are widely varied, and
there are several :ref:`planned-variation` currently under consideration
to capture this diversity.

.. include:: defs/Variation.rst

.. _MolecularVariation:

Molecular Variation
$$$$$$$$$$$$$$$$$$$

.. include:: defs/MolecularVariation.rst

.. _SystemicVariation:

Systemic Variation
$$$$$$$$$$$$$$$$$$

.. include:: defs/SystemicVariation.rst


Loading

0 comments on commit 8668b15

Please sign in to comment.