Addresses epic #480 task "Create DerivativeMolecule" (#491)

ga4gh · Apr 19, 2024 · 6a8e955 · 6a8e955
1 parent ab0c6e7
commit 6a8e955
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 2 deletions.
diff --git a/docs/source/concepts/molecular_variation/Adjacency.rst b/docs/source/concepts/molecular_variation/Adjacency.rst
@@ -5,7 +5,7 @@ Adjacency
 
 .. admonition:: New in v2
 
-   The adjacency class was added in v2 to describe structural variation.
+   The Adjacency class was added in v2 to describe structural variation.
 
 The adjacency class is a core concept for structural variation, representing the junction point of 
 two adjoined molecules. This class can be used on its own (e.g. for junctions of chimeric transcript fusions)

diff --git a/docs/source/concepts/molecular_variation/DerivativeMolecule.rst b/docs/source/concepts/molecular_variation/DerivativeMolecule.rst
@@ -0,0 +1,15 @@
+.. _DerivativeMolecule:
+
+DerivativeMolecule
+!!!!!!!!!!!!!!!!!!
+
+.. admonition:: New in v2
+   The DerivativeMolecule class was added in v2 to describe structural variation.
+
+DerivativeMolecule is a data class for describing a derivate molecule represented by
+adjoined molecular sequences. This is the structure that can be used to recreate 
+genomic rearrangements such as inversions or translocations. It also allows for the
+description of intervening sequence content through  
+
+This class is under development. See `#461 <https://github.com/ga4gh/vrs/discussions/461>`_
+for current discussion.
diff --git a/docs/source/concepts/molecular_variation/DerivativeSequence.rst b/docs/source/concepts/molecular_variation/DerivativeSequence.rst
diff --git a/docs/source/concepts/molecular_variation/index.rst b/docs/source/concepts/molecular_variation/index.rst
@@ -5,6 +5,6 @@ This is a document describing molecular variation
    Allele
    Adjacency
    CisPhasedBlock
-   DerivativeSequence
+   DerivativeMolecule
    SequenceTerminus