From 17fd343ca751b22c62c0a8883f54ec7d6cd4662e Mon Sep 17 00:00:00 2001
From: Xavier Robin <xavier.robin@unibas.ch>
Date: Wed, 28 Aug 2019 10:01:36 +0200
Subject: [PATCH] Document To and From String functions for Alignments and
Sequences
---
modules/io/doc/io.rst | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/modules/io/doc/io.rst b/modules/io/doc/io.rst
index 35e71011f..a00d8c383 100644
--- a/modules/io/doc/io.rst
+++ b/modules/io/doc/io.rst
@@ -236,6 +236,15 @@ Loading sequence or alignment files
:exc:`~ost.io.IOException` if the import fails due to an erroneous or
inexistent file.
+.. function:: AlignmentFromString(data, format)
+.. function:: SequenceFromString(data, format)
+.. function:: SequenceListFromString(data, format)
+
+ Load alignment, sequence or list of sequences from string.
+
+ The format argument is mandatory. For a list of supported formats,
+ see :doc:`sequence_formats`.
+
Saving Sequence Data
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -278,6 +287,14 @@ Saving Sequence Data
For a list of file formats supported by :func:`SaveAlignment` see
:doc:`sequence_formats`.
+.. function:: AlignmentToString(ali, format)
+.. function:: SequenceToString(seq, format)
+.. function:: SequenceListToString(seq_list, format)
+
+ Return alignment, sequence or sequence list as a string.
+
+ The format argument is mandatory. For a list of supported formats
+ see :doc:`sequence_formats`.
.. _img-io:
--
GitLab