Skip to content

Commit

Permalink
explain added parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
lh3 committed Aug 6, 2018
1 parent b0f39a1 commit a1b7219
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions python/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,17 @@ Class mappy.Aligner

.. code:: python
mappy.Aligner(fn_idx_in, preset=None, ...)
mappy.Aligner(fn_idx_in=None, preset=None, ...)
This constructor accepts the following arguments:

* **fn_idx_in**: index or sequence file name. Minimap2 automatically tests the
file type. If a sequence file is provided, minimap2 builds an index. The
sequence file can be optionally gzip'd.
sequence file can be optionally gzip'd. This option has no effect if **seq**
is set.

* **seq**: a single sequence to index. The sequence name will be set to
:code:`N/A`.

* **preset**: minimap2 preset. Currently, minimap2 supports the following
presets: **sr** for single-end short reads; **map-pb** for PacBio
Expand All @@ -79,7 +83,10 @@ This constructor accepts the following arguments:

* **n_threads**: number of indexing threads; 3 by default

* **fn_idx_out**: name of file to which the index is written
* **extra_flags**: additional flags defined in minimap.h

* **fn_idx_out**: name of file to which the index is written. This parameter
has no effect if **seq** is set.

.. code:: python
Expand Down

0 comments on commit a1b7219

Please sign in to comment.