Merge pull request icgc-argo-workflows#2 from ICGC-TCGA-PanCancer/demo-fastqc1-wf@0.1.0

[release]

Author: junjun-zhang

demo-fastqc1-wf/.gitignore

@@ -0,0 +1,69 @@
+*.py[cod]
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+.eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+venv*/
+pyvenv*/
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+.coverage.*
+nosetests.xml
+coverage.xml
+htmlcov
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+.idea
+*.iml
+*.komodoproject
+
+# Complexity
+output/*.html
+output/*/index.html
+
+# Sphinx
+docs/_build
+
+.DS_Store
+*~
+.*.sw[po]
+.build
+.ve
+.env
+.cache
+.pytest
+.bootstrap
+.appveyor.token
+*.bak
+*.log
+.vscode
+.python-version
+.nextflow*
+work
+outdir

demo-fastqc1-wf/demo-fastqc1-wf.nf

@@ -0,0 +1,41 @@
+#!/usr/bin/env nextflow
+
+nextflow.enable.dsl = 2
+version = '0.1.0'  // package version
+
+// universal params go here, change default value as needed
+params.container = ""
+params.container_registry = ""
+params.container_version = ""
+params.cpus = 1
+params.mem = 1  // GB
+params.publish_dir = ""  // set to empty string will disable publishDir
+
+// tool specific parmas go here, add / change as needed
+params.input_file = ""
+params.cleanup = true
+
+include { cleanupWorkdir; getSecondaryFiles; getBwaSecondaryFiles } from './wfpr_modules/github.com/icgc-argo/demo-wfpkgs/demo-utils@1.3.0/main.nf' params([*:params, 'cleanup': false])
+include { demoFastqc1 } from './wfpr_modules/github.com/icgc-tcga-pancancer/demo-pkgs1/demo-fastqc1@0.1.0/demo-fastqc1' params([*:params, 'cleanup': false])
+
+
+// please update workflow code as needed
+workflow DemoFastqc1Wf {
+  take:  // update as needed
+    input_file
+
+
+  main:  // update as needed
+    demoFastqc1(input_file)
+    if (params.cleanup) { cleanupWorkdir(demoFastqc1.out, true) }
+
+  emit:  // update as needed
+    output_file = demoFastqc1.out.output_file
+}
+
+
+workflow {
+  DemoFastqc1Wf(
+    file(params.input_file)
+  )
+}

demo-fastqc1-wf/local_modules/demo-copy-file.nf

@@ -0,0 +1,29 @@
+#!/usr/bin/env nextflow
+
+/*
+ This is an example process as a local module. Using local module is optional, in general
+ is discouraged. A process can pentially be reused in different workflows should be developed
+ in an independent package, so that it can be imported by anyone into any workflow.
+*/
+
+nextflow.enable.dsl = 2
+
+params.input_file = ""
+params.publish_dir = ""
+
+
+process demoCopyFile {
+  publishDir "${params.publish_dir}/${task.process.replaceAll(':', '_')}", mode: "copy", enabled: "${params.publish_dir ? true : ''}"
+
+  input:
+    path input_file
+
+  output:
+    path "output_dir/*", emit: output_file
+
+  script:
+    """
+    mkdir output_dir
+    cp ${input_file} output_dir/
+    """
+}

demo-fastqc1-wf/nextflow.config

@@ -0,0 +1,4 @@
+docker {
+    enabled = true
+    runOptions = '-u \$(id -u):\$(id -g)'
+}

demo-fastqc1-wf/pkg.json

@@ -0,0 +1,33 @@
+{
+    "name": "demo-fastqc1-wf",
+    "version": "0.1.0",
+    "description": "FastQC workflow",
+    "main": "demo-fastqc1-wf",
+    "scripts": {
+        "test": "wfpm test"
+    },
+    "deprecated": false,
+    "keywords": [
+        "bioinformatics",
+        "seq",
+        "qc metrics"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/icgc-tcga-pancancer/demo-pkgs2.git"
+    },
+    "dependencies": [
+        "github.com/icgc-argo/demo-wfpkgs/demo-utils@1.3.0",
+        "github.com/icgc-tcga-pancancer/demo-pkgs1/demo-fastqc1@0.1.0"
+    ],
+    "devDependencies": [],
+    "contributors": [
+        {
+            "name": "Junjun Zhang",
+            "email": "junjun.ca@gmail.com"
+        }
+    ],
+    "license": "MIT",
+    "bugReport": "https://github.com/icgc-tcga-pancancer/demo-pkgs2/issues",
+    "homepage": "https://github.com/icgc-tcga-pancancer/demo-pkgs2#readme"
+}

demo-fastqc1-wf/tests/checker.nf

@@ -0,0 +1,74 @@
+#!/usr/bin/env nextflow
+
+/*
+ This is an auto-generated checker workflow to test the generated main template workflow, it's
+ meant to illustrate how testing works. Please update to suit your own needs.
+*/
+
+nextflow.enable.dsl = 2
+version = '0.1.0'  // package version
+
+// universal params
+params.publish_dir = ""
+params.container = ""
+params.container_registry = ""
+params.container_version = ""
+
+// tool specific parmas go here, add / change as needed
+params.input_file = ""
+params.expected_output = ""
+params.cleanup = false
+
+include { DemoFastqc1Wf } from '../demo-fastqc1-wf' params(['cleanup': false, *:params])
+// include section starts
+// include section ends
+
+Channel
+  .fromPath(params.input_file, checkIfExists: true)
+  .set { input_file }
+
+
+process file_smart_diff {
+  input:
+    path output_file
+    path expected_file
+
+  output:
+    stdout()
+
+  script:
+    """
+    # Note: this is only for demo purpose, please write your own 'diff' according to your own needs.
+    # remove date field before comparison eg, <div id="header_filename">Tue 19 Jan 2021<br/>test_rg_3.bam</div>
+    # sed -e 's#"header_filename">.*<br/>test_rg_3.bam#"header_filename"><br/>test_rg_3.bam</div>#'
+
+    diff <( cat ${output_file} | sed -e 's#"header_filename">.*<br/>#"header_filename"><br/>#' ) \
+         <( ([[ '${expected_file}' == *.gz ]] && gunzip -c ${expected_file} || cat ${expected_file}) | sed -e 's#"header_filename">.*<br/>#"header_filename"><br/>#' ) \
+    && ( echo "Test PASSED" && exit 0 ) || ( echo "Test FAILED, output file mismatch." && exit 1 )
+    """
+}
+
+
+workflow checker {
+  take:
+    input_file
+    expected_output
+
+  main:
+    DemoFastqc1Wf(
+      input_file
+    )
+
+    file_smart_diff(
+      DemoFastqc1Wf.out.output_file,
+      expected_output
+    )
+}
+
+
+workflow {
+  checker(
+    file(params.input_file),
+    file(params.expected_output)
+  )
+}

demo-fastqc1-wf/tests/expected/expected.test_rg_3.bam

@@ -0,0 +1 @@
+This folder contains tiny data files for testing.