Commit 9fc2caf5 by Eric Coissac

change obigrep doc

parent 870e1d62
#!/usr/local/bin/python
'''
:py:mod:`obihead` : Extracts the first sequences
================================================
:py:mod:`obihead` : Extracts the first sequence records
=======================================================
.. codeauthor:: Eric Coissac <eric.coissac@metabarcoding.org>
:py:mod:`obihead` command is in some way analog to the standard Unix `head` command.
It selects the head of :ref:`a sequence file <format>`.
It selects the head of :ref:`a sequence file <../format>`.
But instead of working text line by text line as the standard Unix tool,
selection is done at the sequence level. You can specify the number of sequences to select.
selection is done at the sequence record level. You can specify the number of sequence records
to select.
*Example:*
Example
-------
.. code-block:: bash
.. code-block:: bash
> obihead -n 150 seq1.fasta > seq2.fasta
> obihead -n 150 seq1.fasta > seq2.fasta
Selects the 150 first sequences from the ``seq1.fasta`` file and stores
them into the ``seq2.fasta`` file.
Selects the 150 first sequence records from the ``seq1.fasta`` file and stores
them into the ``seq2.fasta`` file.
'''
......
#!/usr/local/bin/python
'''
:py:mod:`obitail` : Extracts the last sequences
===============================================
:py:mod:`obitail` : Extracts the last sequence records
======================================================
.. codeauthor:: Eric Coissac <eric.coissac@metabarcoding.org>
:py:mod:`obitail` command is in some way analog to the standard Unix `tail` command.
It selects the tail of :ref:`a sequence file <format>`.
It selects the tail of :ref:`a sequence file <../format>`.
But instead of working text line by text line as the standard Unix tool,
selection is done at the sequence level. You can specify the number of sequences to select.
selection is done at the sequence record level. You can specify the number of
sequence records to select.
Example
-------
*Example:*
.. code-block:: bash
.. code-block:: bash
> obitail -n 150 seq1.fasta > seq2.fasta
> obitail -n 150 seq1.fasta > seq2.fasta
Selects the 150 last sequences from the ``seq1.fasta`` file and stores
them into the ``seq2.fasta`` file.
Selects the 150 last sequence records from the ``seq1.fasta`` file and stores
them into the ``seq2.fasta`` file.
'''
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment