Merge branch 'dev' into refactor-arguments

Signed-off-by: Joon Klaps <joon.klaps@kuleuven.be>

Author: Joon-Klaps

.nf-core.yml

@@ -23,7 +23,6 @@ lint:
     - manifest.name
     - manifest.homePage
     - config_defaults:
-        - params.multiqc_comment_headers
         - params.custom_table_headers
   multiqc_config: false
   files_exist:

CHANGELOG.md

@@ -26,7 +26,7 @@ Initial release of Joon-Klaps/viralgenie, created with the [nf-core](https://nf-
 - Constrain -> Constraint & further python script debugging ([#161](https://github.com/Joon-Klaps/viralgenie/pull/161))
 - include empty samples in multiqc sample overview ([#162](https://github.com/Joon-Klaps/viralgenie/pull/162))
 - Include samtools stats pre dedup & post dedup in overview tables ([#163](https://github.com/Joon-Klaps/viralgenie/pull/163))
-- adding prodigal with fitler setup for selecting final result genomes ([#165](https://github.com/Joon-Klaps/viralgenie/pull/165))
+- adding prokka for gene detection & annotation ([#165](https://github.com/Joon-Klaps/viralgenie/pull/165))
 - Refactor module arguments to pipeline arguments ([#166](https://github.com/Joon-Klaps/viralgenie/pull/166))
 
 ### `Fixed`

CITATIONS.md

@@ -103,6 +103,10 @@
 
 - [picard-tools](http://broadinstitute.github.io/picard)
 
+- [prokka](https://pubmed.ncbi.nlm.nih.gov/24642063/)
+
+    > Seemann, Torsten. “Prokka: rapid prokaryotic genome annotation.” Bioinformatics (Oxford, England) vol. 30,14 (2014): 2068-9. doi:10.1093/bioinformatics/btu153
+
 - [QUAST](https://www.ncbi.nlm.nih.gov/pubmed/23422339/)
 
     > Gurevich, Alexey et al. “QUAST: quality assessment tool for genome assemblies.” Bioinformatics (Oxford, England) vol. 29,8 (2013): 1072-5. doi:10.1093/bioinformatics/btt086

docs/output.md

@@ -700,6 +700,16 @@ Consensus quality control is done with multiple tools, the results are stored in
         - `<sample-id>/<sample-id>_<cl# | constraint-id>/contamination.tsv`: A detailed overview of how contamination was estimated.
         - `<sample-id>/<sample-id>_<cl# | constraint-id>/complete_genomes.tsv`: A detailed overview of putative genomes identified.
 
+
+### Prokka
+
+[`Prokka`](https://github.com/tseemann/prokka) is a whole genome annotation pipeline for identifying features of interest in a set of genomic DNA sequences, and labelling them with useful information. Prokka is a software tool to annotate bacterial, archaeal and viral genomes.)
+
+???- abstract "Output files"
+
+    - `consensus/quality_control/prokka/`
+        - `<sample-id>/<iteration>/* directories containing the prokka output files.
+
 ### BLASTn
 
 [BLAST](https://blast.ncbi.nlm.nih.gov/Blast.cgi) is a tool for comparing primary biological sequence information. The output from the BLAST run is stored in the directory `consensus/quality_control/blast/`. Final consensus genomes are searched against the `--reference_pool`.
@@ -790,11 +800,15 @@ Furthermore, viralgenie runs MultiQC 2 times, as it uses the output from multiqc
 
 ???- abstract "Output files"
     -   `multiqc/`
-        -   `overview-tables/`: a directory with a set of commented TSV (comments taken from `--multiqc_comment_headers`) that summarize aspects of the pipeline runs.
         -   `multiqc_report.html`: a standalone HTML file that can be viewed in your web browser.
         -   `multiqc_data/`: directory containing parsed statistics from the different tools used in the pipeline.
         -   `multiqc_dataprep/`: preparation files for the generated custom tables.
         -   `multiqc_plots/`: directory containing static images from the report in various formats.
+    -   `overview-tables/`: a directory with a set of summary TSV files.
+      - `contigs_overview_with_iterations.tsv`: A tabular file containing the contig information of the final __contig consensus__ genome and their intermediate iterations.
+      - `contigs_overview.tsv`: A tabular file containing the contig information of the final __contig consensus__ genome.
+      - `mapping_overview.tsv`: A tabular file containing the mapping information of the final __mapped consensus__ genome, from the argument `--mapping_constraints`.
+      - `samples_overview.tsv`: A tabular file containing the sample information combining information from both `contigs_overview.tsv` & `mapping_overview.tsv`.
 
 ## Pipeline information
 

docs/workflow/consensus_qc.md

@@ -30,7 +30,19 @@ Within the MultiQC report, Viralgenie provides a number of custom tables based o
 
 > CheckV can be skipped with `--skip_checkv`.
 
-## BLASTn
+
+## Prokka
+[Prokka](https://github.com/tseemann/prokka) is a whole genome annotation pipeline for identifying features of interest in a set of genomic DNA sequences, and labelling them with useful information. Prokka is a software tool to annotate bacterial, archaeal and viral genomes.
+
+!!! Tip "Suboptimal annotation"
+    Prokka was initially designed for bacterial and archaeal genomes, and may not be optimal for viral genomes. [VIGOR4](https://github.com/JCVenterInstitute/VIGOR4) is a good alternative but is species specific.
+
+!!! Tip "Custom protein database"
+    Prokka can be given a custom protein database to annotate your genomes with, have a look at [prot-RVDB](https://rvdb-prot.pasteur.fr/) for viral protein databases. Supply the database using `--prokka_db`.
+
+> Prokka can be skipped with `--skip_prokka`.
+
+## BLAST
 
 [blastn](https://blast.ncbi.nlm.nih.gov/Blast.cgi) is a tool for comparing primary biological sequence information. It calculates the similarity between the consensus genome and the reference genome. The similarity is calculated based on the number of identical bases between the two sequences. Viralgenie uses blastn to compare the sequences against the supplied `--reference_pool` dataset.
 

modules/local/custom_multiqc/main.nf

@@ -18,7 +18,6 @@ process CUSTOM_MULTIQC {
     path anno_files, stageAs: "?/annotation/*"
     path clusters_tsv, stageAs: "?/clusters/*"
     path screen_files, stageAs: "?/screen/*"
-    path comment_headers
     path custom_table_headers
 
     output:
@@ -48,7 +47,6 @@ process CUSTOM_MULTIQC {
     def clusters_files                 = clusters_tsv           ? "--clusters_files ${clusters_tsv}"             : ''
     def mapping_constraints_command     = mapping_constraints     ? "--mapping_constraints ${mapping_constraints}"   : ''
     def screen_files_command           = screen_files           ? "--screen_files ${screen_files}"               : ''
-    def comment_headers_command        = comment_headers        ? "--comment_dir ${comment_headers}"             : ''
     def custom_table_headers_command   = custom_table_headers   ? "--table_headers ${custom_table_headers}"      : ''
 
     """
@@ -65,7 +63,6 @@ process CUSTOM_MULTIQC {
         $clusters_files \\
         $mapping_constraints_command \\
         $screen_files_command \\
-        $comment_headers_command \\
         $custom_table_headers_command \\
 
 

workflows/viralgenie.nf

@@ -91,7 +91,6 @@ workflow VIRALGENIE {
     ch_multiqc_custom_config              = params.multiqc_config ? Channel.fromPath( params.multiqc_config, checkIfExists: true ) : Channel.empty()
     ch_multiqc_logo                       = params.multiqc_logo   ? Channel.fromPath( params.multiqc_logo, checkIfExists: true ) : Channel.empty()
     ch_multiqc_custom_methods_description = params.multiqc_methods_description ? file(params.multiqc_methods_description, checkIfExists: true) : file("$projectDir/assets/methods_description_template.yml", checkIfExists: true)
-    ch_multiqc_comment_headers            = params.multiqc_comment_headers     ? Channel.fromPath(params.multiqc_comment_headers, checkIfExists:true ) : Channel.empty()
     ch_multiqc_custom_table_headers       = params.custom_table_headers        ? Channel.fromPath(params.custom_table_headers, checkIfExists:true ) : Channel.empty()
 
 
@@ -492,7 +491,6 @@ workflow VIRALGENIE {
         ch_annotation_summary.ifEmpty([]),
         ch_clusters_tsv.ifEmpty([]),
         ch_mash_screen.ifEmpty([]),
-        ch_multiqc_comment_headers.ifEmpty([]),
         ch_multiqc_custom_table_headers.ifEmpty([])
         )
     ch_versions = ch_versions.mix(CUSTOM_MULTIQC.out.versions)