Skip to content
Snippets Groups Projects
Unverified Commit e9a0192f authored by Xavier Robin's avatar Xavier Robin
Browse files

doc: refactor seq.alg submodules

parent 1a1723df
Branches
Tags
No related merge requests found
...@@ -13,16 +13,26 @@ OpenStructure documentation ...@@ -13,16 +13,26 @@ OpenStructure documentation
geom/geom geom/geom
mol/base/mol mol/base/mol
mol/alg/molalg mol/alg/molalg
mol/alg/chain_mapping
mol/alg/contact_score
mol/alg/dockq
mol/alg/helix_kinks
mol/alg/ligand_scoring
mol/alg/qsscore
mol/alg/scoring
mol/alg/stereochemistry
mol/alg/structure_analysis
mol/alg/trajectory_analysis
mol/mm/molmm mol/mm/molmm
conop/conop conop/conop
img/base/img img/base/img
img/alg/alg img/alg/alg
seq/base/seq seq/base/seq
seq/alg/seqalg seq/alg/seqalg
seq/alg/renumber
seq/alg/aaindex
db/db db/db
bindings/bindings bindings/bindings
io/io io/io
gfx/gfx gfx/gfx
gui/gui gui/gui
......
:mod:`mol.alg.stereochemistry <ost.mol.alg.stereochemistry>` -- Stereochemistry Checks :mod:`mol.alg.stereochemistry <ost.mol.alg.stereochemistry>` -- Stereochemistry Checks
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------------
.. warning:: .. warning::
......
:mod:`seq.alg.aaindex <ost.seq.alg.aaindex>` -- AAIndex annotations
--------------------------------------------------------------------------------
.. module:: ost.seq.alg.aaindex
:synopsis: AAIndex annotations
.. autoclass:: ost.seq.alg.aaindex.AAIndex
:members:
:special-members: __getitem__
The annotations/scores can either refer to single amino acids or represent
pairwise values. The two types are:
.. autoclass:: ost.seq.alg.aaindex.AnnoType
:members:
:undoc-members:
The actual data of an entry in the aaindex database is stored in a
:class:`aaindex.AAIndexData` object:
.. autoclass:: ost.seq.alg.aaindex.AAIndexData
:members:
:mod:`seq.alg.renumber <ost.seq.alg.renumber>` -- Renumber entities
--------------------------------------------------------------------
.. module:: ost.seq.alg.renumber
:synopsis: Renumber entities
.. autofunction:: ost.seq.alg.renumber.Renumber
...@@ -4,6 +4,12 @@ ...@@ -4,6 +4,12 @@
.. module:: ost.seq.alg .. module:: ost.seq.alg
:synopsis: Algorithms for sequences :synopsis: Algorithms for sequences
Submodules
--------------------------------------------------------------------------------
* :doc:`aaindex – AAIndex annotations <aaindex>`
* :doc:`renumber – Renumber entities <renumber>`
Algorithms for Alignments Algorithms for Alignments
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
...@@ -123,8 +129,6 @@ Algorithms for Alignments ...@@ -123,8 +129,6 @@ Algorithms for Alignments
:returns: List of column entropies :returns: List of column entropies
.. autofunction:: ost.seq.alg.renumber.Renumber
.. function:: SequenceIdentity(aln, ref_mode=seq.alg.RefMode.ALIGNMENT, seq_a=0, seq_b=1) .. function:: SequenceIdentity(aln, ref_mode=seq.alg.RefMode.ALIGNMENT, seq_a=0, seq_b=1)
Calculates the sequence identity between two sequences at index seq_a and seq_b in Calculates the sequence identity between two sequences at index seq_a and seq_b in
...@@ -1035,23 +1039,3 @@ etc.) to be set, which is the case if you load a file in hhm format. ...@@ -1035,23 +1039,3 @@ etc.) to be set, which is the case if you load a file in hhm format.
:raises: Exception if profile doesn't have HMM information assigned :raises: Exception if profile doesn't have HMM information assigned
AAIndex annotations
-------------------
.. autoclass:: ost.seq.alg.aaindex.AAIndex
:members:
:special-members: __getitem__
The annotations/scores can either refer to single amino acids or represent
pairwise values. The two types are:
.. autoclass:: ost.seq.alg.aaindex.AnnoType
:members:
:undoc-members:
The actual data of an entry in the aaindex database is stored in a
:class:`aaindex.AAIndexData` object:
.. autoclass:: ost.seq.alg.aaindex.AAIndexData
:members:
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please to comment