Merge pull request #199 from assemblerflow/dev

Update - version 1.4.1

Author: ODiogoSilva

changelog.md

@@ -2,6 +2,39 @@
 
 ## Changes in upcoming release (`dev` branch) 
 
+
+## 1.4.0
+
+### New features
+
+- Added support for the report system to:
+    - `maxbin2`
+- Added new `manifest.config` with the pipeline metadata
+
+### New components
+
+- `Kraken2`: Taxonomic identification on FastQ files
+
+### Bug fixes
+
+- Fix bug in `momps`component related to added in the introduction of the clear input parameter
+- Fixed bug with the `-ft` parameters not retrieving the dockerhub tags for 
+all the components.
+- Fixed bug in the `megahit` process where the fastg mode would break the process
+- Fix inspect and report mode to fetch the nextflow file independently of its 
+position in the `nextflow run` command inside the .nextflow.log file.
+- Fix parsing of .nextflow.log file when searching for `nextflow run` command.
+- Fixed bug between mash_sketch_fasta and mash_dist.
+
+### Minor/Other changes
+
+- Added option to `dengue_typing` to retrieve closest reference sequence and link it 
+with a secondary channel into `mafft`
+- New version of DEN-IM recipe
+- Now prints an ordered list of components
+- Moved taxonomy results from `results/annotation/` to `results/taxonomy/`
+
+
 ## 1.4.0
 
 ### New features
@@ -41,9 +74,11 @@ resolution
 - Added seed parameter to `downsample_fastq` component.
 - Added bacmet database to `abricate` component.
 - Added default docker option to avoid docker permission errors.
+- Changed the default URL generated by inspect and report commands. 
 - Changed the default URL generated by inspect and report commands.
 - Added directives to `-L` parameter of build module.
 
+
 ### Bug fixes
 
 - Fixed forks with same source process name.

docs/resources/reports/binning.png

@@ -135,6 +135,9 @@ Taxonomic Profiling
 - :doc:`components/kraken`: Performs taxonomic identification with kraken on FastQ files
   (minikrakenDB2017 as default database)
 
+- :doc:`components/kraken2`: Performs taxonomic identification with kraken2 on FastQ files
+  (minikraken2_v1_8GB as default database)
+
 - :doc:`components/midas_species`: Performs taxonomic identification on FastQ files at the
   species level with midas (requires database)
 

docs/user/available_components.rst

@@ -27,7 +27,7 @@ Parameters
 Published results
 -----------------
 
-- ``results/annotation/kraken``: Stores the results of the screening
+- ``results/taxonomy/kraken``: Stores the results of the screening
   for each sample.
 
 Published reports

docs/user/components/kraken.rst

@@ -0,0 +1,45 @@
+kraken2
+=======
+
+Purpose
+-------
+
+This component performs Kraken2 to assign taxonomic labels to short DNA
+sequences, usually obtained through metagenomic studies.
+
+.. note::
+    Software page: https://ccb.jhu.edu/software/kraken2/
+
+Input/Output type
+------------------
+
+- Input type: ``FastQ``
+- Output type: txt
+
+.. note::
+    The default input parameter for fastq data is ``--fastq``.
+
+Parameters
+----------
+
+- ``kraken2DB``: Specifies kraken2 database. Default: minikraken2_v1_8GB (in path inside the
+default container)
+
+Published results
+-----------------
+
+- ``results/taxonomy/kraken2``: Stores the results of the screening
+  for each sample.
+
+Published reports
+-----------------
+
+None.
+
+Default directives
+------------------
+
+- ``container``: flowcraft/kraken2
+- ``version``: 2.0.7-1
+- ``cpus``: 3
+- ``memory``: 5GB (dynamically increased on retry)

docs/user/components/kraken2.rst

@@ -45,5 +45,11 @@ Default directives
 
 - ``container``: flowcraft/maxbin2
 - ``version``: 2.2.4-1
-- ``cpus``: 3
-- ``memory``: 5.GB * task.attempt
+- ``cpus``: 4
+- ``memory``: 8.GB (dynamically increased on retry)
+
+
+Template
+^^^^^^^^
+
+:mod:`assemblerflow.templates.maxbin2`

docs/user/components/maxbin2.rst

@@ -27,6 +27,11 @@ Parameters
   from the maximum read length of each assembly. If 'default', megahit will
   use the default k-mer lengths.
 
+- ``fastg``: When true, it converts megahit intermediate contigs into fastg.
+  Default: False
+
+
+
 Published results
 -----------------
 

docs/user/components/megahit.rst

@@ -27,7 +27,7 @@ Parameters
 Published results
 -----------------
 
-- ``results/annotation/midas``: Stores the results of the screening
+- ``results/taxonomy/midas``: Stores the results of the screening
   for each sample.
 
 Published reports

docs/user/components/midas_species.rst

@@ -14,7 +14,7 @@ determine the raw input type, and the parameter for providing input data.
 The input type information is provided in the documentation page of each
 component. For instance, if the first component is FastQC, which has an input
 type of ``FastQ``, the parameter for providing the raw input data will be
-``--fasta``. Here are the currently supported input types and their
+``--fastq``. Here are the currently supported input types and their
 respective parameters:
 
 - ``FastQ``: ``--fastq``

docs/user/pipeline_building.rst

@@ -0,0 +1,15 @@
+maxbin2
+----
+
+Table data
+^^^^^^^^^^
+
+Metagenomic Binning (sample specific):
+    - **Bin name**: The number of bin.
+    - **Completness**: Estimation of completion of genome in bin (% of Single copy genes present)
+    - **Genome size**: Total size of the bin
+    - **GC content**: Percentage of GC in the bin
+
+.. image:: ../resources/reports/binning.png
+    :scale: 80 %
+    :align: center