obitools/obitools
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added newlines in obigrep doc to make it more readable in terminal

Browse Source
This commit is contained in:
Céline Mercier
2013-04-18 13:49:51 +00:00
parent ececb94e6a
commit 6c4973815f
1 changed files with 11 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
src/obigrep.py
View File

@ -5,18 +5,21 @@
.. codeauthor:: Eric Coissac <eric.coissac@metabarcoding.org>
The :py:mod:`obigrep` command is in some way analog to the standard Unix ``grep`` command.
The :py:mod:`obigrep` command is in some way analog to the standard Unix ``grep``
command.
It selects a subset of sequence records from a :ref:`sequence file <../format>`.
A sequence record is a :doc:`complex object <../fasta>` composed of an identifier, a set of attributes (``key=value``),
a definition, and the sequence itself.
A sequence record is a :doc:`complex object <../fasta>` composed of an identifier,
a set of attributes (``key=value``), a definition, and the sequence itself.
Instead of working text line by text line as the standard Unix tool, selection is done sequence record by sequence record.
A large set of options allows refining selection on any of the sequence record elements.
Moreover :py:mod:`obigrep` allows specifying simultaneously several conditions (that take the value ``TRUE`` or ``FALSE``)
and only the sequence records that fulfill all the conditions (all conditions are ``TRUE``) are selected.
Instead of working text line by text line as the standard Unix tool, selection is
done sequence record by sequence record.
A large set of options allows refining selection on any of the sequence record
elements.
Moreover :py:mod:`obigrep` allows specifying simultaneously several conditions (that
take the value ``TRUE`` or ``FALSE``) and only the sequence records that fulfill all
the conditions (all conditions are ``TRUE``) are selected.
'''