Skip to content

Commit 36e5696

Browse files
committed
🔥 clean-up comments from template
1 parent 208f69f commit 36e5696

File tree

1 file changed

+1
-45
lines changed

1 file changed

+1
-45
lines changed

modules/local/acore/main.nf

Lines changed: 1 addition & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,25 @@
1-
// TODO nf-core: If in doubt look at other nf-core/modules to see how we are doing things! :)
2-
// https://github.com/nf-core/modules/tree/master/modules/nf-core/
3-
// You can also ask for help via your pull request or on the #modules channel on the nf-core Slack workspace:
4-
// https://nf-co.re/join
5-
// TODO nf-core: A module file SHOULD only define input and output files as command-line parameters.
6-
// All other parameters MUST be provided using the "task.ext" directive, see here:
7-
// https://www.nextflow.io/docs/latest/process.html#ext
8-
// where "task.ext" is a string.
9-
// Any parameters that need to be evaluated in the context of a particular sample
10-
// e.g. single-end/paired-end data MUST also be defined and evaluated appropriately.
11-
// TODO nf-core: Software that can be piped together SHOULD be added to separate module files
12-
// unless there is a run-time, storage advantage in implementing in this way
13-
// e.g. it's ok to have a single module for bwa to output BAM instead of SAM:
14-
// bwa mem | samtools view -B -T ref.fasta
15-
// TODO nf-core: Optional inputs are not currently supported by Nextflow. However, using an empty
16-
// list (`[]`) instead of a file can be used to work around this issue.
17-
181
process ACORE {
19-
// tag "$meta.id"
202
label 'process_single'
213

22-
// TODO nf-core: See section in main README for further information regarding finding and adding container addresses to the section below.
234
conda "${moduleDir}/environment.yml"
245
container "${ workflow.containerEngine == 'singularity' && !task.ext.singularity_pull_docker_container ?
256
'https://depot.galaxyproject.org/singularity/YOUR-TOOL-HERE':
267
'biocontainers/YOUR-TOOL-HERE' }"
278

28-
input:// TODO nf-core: Where applicable all sample-specific information e.g. "id", "single_end", "read_group"
29-
// MUST be provided as an input via a Groovy Map called "meta".
30-
// This information may not be required in some instances e.g. indexing reference genome files:
31-
// https://github.com/nf-core/modules/blob/master/modules/nf-core/bwa/index/main.nf
32-
// TODO nf-core: Where applicable please provide/convert compressed files as input/output
33-
// e.g. "*.fastq.gz" and NOT "*.fastq", "*.bam" and NOT "*.sam" etc.
9+
input:
3410
path input_csv
3511
path nb
3612

3713
output:
38-
// TODO nf-core: Named file extensions MUST be emitted for ALL output channels
3914
path "analysis.ipynb", emit: nb
4015
path "report_files", emit: report_files
41-
// TODO nf-core: List additional required output channels/values here
4216
path "versions.yml", emit: versions
4317

4418
when:
4519
task.ext.when == null || task.ext.when
4620

4721
script:
4822
def args = task.ext.args ?: ''
49-
// def prefix = task.ext.prefix ?: "${meta.id}"
50-
// TODO nf-core: Where possible, a command MUST be provided to obtain the version number of the software e.g. 1.10
51-
// If the software is unable to output a version number on the command-line then it can be manually specified
52-
// e.g. https://github.com/nf-core/modules/blob/master/modules/nf-core/homer/annotatepeaks/main.nf
53-
// Each software used MUST provide the software name and version number in the YAML version file (versions.yml)
54-
// TODO nf-core: It MUST be possible to pass additional parameters to the tool as a command-line string via the "task.ext.args" directive
55-
// TODO nf-core: If the tool supports multi-threading then you MUST provide the appropriate parameter
56-
// using the Nextflow "task" variable e.g. "--threads $task.cpus"
57-
// TODO nf-core: Please replace the example samtools command below with your module's command
58-
// TODO nf-core: Please indent the command appropriately (4 spaces!!) to help with readability ;)
5923
"""
6024
papermill \\
6125
$args \\
@@ -73,14 +37,6 @@ process ACORE {
7337

7438
stub:
7539
def args = task.ext.args ?: ''
76-
// def prefix = task.ext.prefix ?: "${meta.id}"
77-
// TODO nf-core: A stub section should mimic the execution of the original module as best as possible
78-
// Have a look at the following examples:
79-
// Simple example: https://github.com/nf-core/modules/blob/818474a292b4860ae8ff88e149fbcda68814114d/modules/nf-core/bcftools/annotate/main.nf#L47-L63
80-
// Complex example: https://github.com/nf-core/modules/blob/818474a292b4860ae8ff88e149fbcda68814114d/modules/nf-core/bedtools/split/main.nf#L38-L54
81-
// TODO nf-core: If the module doesn't use arguments ($args), you SHOULD remove:
82-
// - The definition of args `def args = task.ext.args ?: ''` above.
83-
// - The use of the variable in the script `echo $args ` below.
8440
"""
8541
echo $args
8642

0 commit comments

Comments
 (0)