Skip to content
Snippets Groups Projects
Commit c21d1e7d authored by Marco Biasini's avatar Marco Biasini
Browse files

document a few more AlignmentHandle methods

parent d1052ecf
Branches
Tags
No related merge requests found
...@@ -388,3 +388,47 @@ an alignment: ...@@ -388,3 +388,47 @@ an alignment:
:raises: In case one of the two sequences doesn't have an attached view, a :raises: In case one of the two sequences doesn't have an attached view, a
:exc:`RuntimeError` is raised. :exc:`RuntimeError` is raised.
.. method:: AddSequence(sequence)
Append a sequence to the alignment. The sequence must have the same length as
sequences already present in the alignment.
:raises: :exc:`RuntimeError` if the sequence length does not match
:param sequence: Sequence to be added
:type sequence: :class:`ConstSequenceHandle`
.. method:: GetSequenceOffset(index)
SetSequenceOffset(index, offset)
Get/set the offset for sequence at *index*.
:param index: The index of the sequence
:type index: :class:`int`
:param offset: The new offset
:type offset: :class:`int`
:rtype: :class:`int`
.. method:: GetSequenceRole(index)
SetSequenceRole(index, role)
Get/Set the sequence role for sequence at *index*.
:param index: The index of the sequence
:type index: :class:`int`
:param role: The new role
:type role: :class:`str`
:rtype: :class:`str`
.. method:: GetCoverage(index)
Get coverage of sequence at *index* to the first sequence.
:param index: The index of the sequence
:type index: :class:`int`
:returns: Coverage as a number between 0 and 1.
.. method:: RemoveSequence(index)
Remove sequence at *index* from the alignment.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment