Merge branch 'new-ci-rules' into 'dev'

Implementing SN new CI rules

See merge request epi2melabs/workflow-containers/wf-isoforms!52

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [unreleased]
+### Changed
+- Better help text on cli
+
 ## [v0.1.2]
 ### Added
 - direct_rna option
@@ -26,5 +30,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - First release
 - Initial port of Snakemake WF from https://github.com/nanoporetech/pipeline-nanopore-ref-isoforms
-
-

lib/WorkflowMain.groovy

@@ -1,16 +1,20 @@
+// This file is based on the nf-core/tools pipeline-template.
+// Changes to this file must be propagated via wf-template.
 
 class WorkflowMain {
 
     // Citation string for pipeline
     public static String citation(workflow) {
-        return "If you use wf-template for your analysis please cite:\n\n" +
+        return "If you use ${workflow.manifest.name} for your analysis please cite:\n\n" +
             "* The nf-core framework\n" +
             "  https://doi.org/10.1038/s41587-020-0439-x\n\n"
     }
 
     // Print help to screen
     public static String help(workflow, params, log) {
-        def command = "nextflow run epi2me-labs/wf-template --fastq <input folder> -profile docker"
+        String line_sep = ' \\ \n\t'
+        def command_example = params.wf.example_cmd.join(line_sep)
+        def command = 'nextflow run ' + workflow.manifest.name + line_sep + command_example
         def help_string = ''
         help_string += NfcoreSchema.paramsHelp(workflow, params, command)
         help_string += '\n' + citation(workflow) + '\n'

nextflow.config

@@ -118,6 +118,14 @@ params {
     // Minimum probability for i consecutive minimizers to be different between read and representative:
     min_prob_no_hits = 0.1
 
+    wf {
+      example_cmd = [
+          "--fastq test_data/fastq",
+          "--ref_genome test_data/SIRV_150601a.fasta",
+          "--ref_annotation test_data/SIRV_isofroms.gtf"
+      ]
+    }
+
 
 }