Skip to content

Commit

Permalink
fix args console
Browse files Browse the repository at this point in the history
  • Loading branch information
hariszaf committed Jul 26, 2023
1 parent ec161ac commit 752282c
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions docs/args_and_params.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ Arguments
``metaGOflow`` has 2 levels where the user sets arguments.
Inline, a few technical arguments are provided as described below:

.. code-block:: bash

.. code-block:: console
-f Forward reads fasta file path (mandatory if and olny if -e not used).
-r Reverse reads fasta file path (mandatory if and olny if -e not used).
-e ENA run accession number. Its raw data will be fetched and then analysed (if used, -f and -r should not me set).
Expand Down Expand Up @@ -100,11 +102,16 @@ as well as, some resources-to-be-used related ones.
|``cut_right`` | Moves a sliding window from front to tail, if meet one window with mean quality < threshold, drops the |
| | bases in the window and the right part, and then stop. |
+---------------------------------+------------------------------------------------------------------------------------------------------------+
|``min-contig-len`` | Minimum length of a contig to be returned |
+---------------------------------+------------------------------------------------------------------------------------------------------------+

For more information about how the different analysis of ``fastp`` is performed, you may
have a look at its `GitHub repository <https://github.com/OpenGene/fastp>`_.

Finally, a number of syst
Finally, a number of system related parameters need to be set.
These parameters do not affect the final data products but they play a crucial role in the time efficiency
of ``metaGOflow``. The size of the sample and the computing resources available need to be taken into account
for the best tuning of those.

+---------------------------------+------------------------------------------------------------------------------------------------------------+
|**Parameter** |**Description** |
Expand All @@ -116,8 +123,6 @@ Finally, a number of syst
+---------------------------------+------------------------------------------------------------------------------------------------------------+
|``interproscan_threads`` | Number of threads to be used for the InterProScan task. |
+---------------------------------+------------------------------------------------------------------------------------------------------------+
|``min-contig-len`` | Minimum length of a contig to be returned |
+---------------------------------+------------------------------------------------------------------------------------------------------------+
|``cgc_chunk_size`` | Size of each chunk to which filtered sequences will be split to to perform the ``cgc_step`` |
+---------------------------------+------------------------------------------------------------------------------------------------------------+
|``protein_chunk_size_IPS`` | Size of each chunk to which the filtered sequences will be split to to perform the InterProScan task |
Expand Down

0 comments on commit 752282c

Please sign in to comment.