Skip to content

Commit a5ac296

Browse files
lindaxianglindaxiang
committed
[wfpm v0.7.11] added starting template for payload-gen-qc@0.1.0
1 parent 4fe0ac4 commit a5ac296

16 files changed

Lines changed: 316 additions & 0 deletions

‎payload-gen-qc/.dockerignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.gitignore
2+
.nextflow*
3+
tests
4+
work
5+
outdir

‎payload-gen-qc/Dockerfile‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
FROM python:3.7.5-slim-buster
2+
3+
LABEL org.opencontainers.image.source https://github.com/icgc-argo-workflows/data-processing-utility-tools
4+
5+
ENV PATH="/tools:${PATH}"
6+
7+
COPY *.py /tools/
8+
9+
ENTRYPOINT ["/usr/bin/env"]
10+
11+
CMD ["/bin/bash"]

‎payload-gen-qc/main.nf‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
#!/usr/bin/env nextflow
2+
3+
/*
4+
Copyright (C) 2021, Ontario Institute for Cancer Research
5+
6+
This program is free software: you can redistribute it and/or modify
7+
it under the terms of the GNU Affero General Public License as published by
8+
the Free Software Foundation, either version 3 of the License, or
9+
(at your option) any later version.
10+
11+
This program is distributed in the hope that it will be useful,
12+
but WITHOUT ANY WARRANTY; without even the implied warranty of
13+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14+
GNU Affero General Public License for more details.
15+
16+
You should have received a copy of the GNU Affero General Public License
17+
along with this program. If not, see <http://www.gnu.org/licenses/>.
18+
19+
Authors:
20+
Linda Xiang
21+
*/
22+
23+
/********************************************************************/
24+
/* this block is auto-generated based on info from pkg.json where */
25+
/* changes can be made if needed, do NOT modify this block manually */
26+
nextflow.enable.dsl = 2
27+
version = '0.1.0' // package version
28+
29+
container = [
30+
'ghcr.io': 'ghcr.io/icgc-argo-workflows/data-processing-utility-tools.payload-gen-qc'
31+
]
32+
default_container_registry = 'ghcr.io'
33+
/********************************************************************/
34+
35+
36+
// universal params go here
37+
params.container_registry = ""
38+
params.container_version = ""
39+
params.container = ""
40+
41+
params.cpus = 1
42+
params.mem = 1 // GB
43+
params.publish_dir = "" // set to empty string will disable publishDir
44+
45+
46+
// tool specific parmas go here, add / change as needed
47+
params.input_file = ""
48+
params.output_pattern = "*" // output file name pattern
49+
50+
51+
process payloadGenQc {
52+
container "${params.container ?: container[params.container_registry ?: default_container_registry]}:${params.container_version ?: version}"
53+
publishDir "${params.publish_dir}/${task.process.replaceAll(':', '_')}", mode: "copy", enabled: params.publish_dir
54+
55+
cpus params.cpus
56+
memory "${params.mem} GB"
57+
58+
input: // input, make update as needed
59+
path input_file
60+
61+
output: // output, make update as needed
62+
path "output_dir/${params.output_pattern}", emit: output_file
63+
64+
script:
65+
// add and initialize variables here as needed
66+
67+
"""
68+
mkdir -p output_dir
69+
70+
main.py \
71+
-i ${input_file} \
72+
-o output_dir
73+
74+
"""
75+
}
76+
77+
78+
// this provides an entry point for this main script, so it can be run directly without clone the repo
79+
// using this command: nextflow run <git_acc>/<repo>/<pkg_name>/<main_script>.nf -r <pkg_name>.v<pkg_version> --params-file xxx
80+
workflow {
81+
payloadGenQc(
82+
file(params.input_file)
83+
)
84+
}

‎payload-gen-qc/main.py‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
#!/usr/bin/env python3
2+
# -*- coding: utf-8 -*-
3+
4+
"""
5+
Copyright (C) 2021, Ontario Institute for Cancer Research
6+
7+
This program is free software: you can redistribute it and/or modify
8+
it under the terms of the GNU Affero General Public License as published by
9+
the Free Software Foundation, either version 3 of the License, or
10+
(at your option) any later version.
11+
12+
This program is distributed in the hope that it will be useful,
13+
but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15+
GNU Affero General Public License for more details.
16+
17+
You should have received a copy of the GNU Affero General Public License
18+
along with this program. If not, see <http://www.gnu.org/licenses/>.
19+
20+
Authors:
21+
Linda Xiang
22+
"""
23+
24+
import os
25+
import sys
26+
import argparse
27+
import subprocess
28+
29+
30+
def main():
31+
"""
32+
Python implementation of tool: payload-gen-qc
33+
34+
This is auto-generated Python code, please update as needed!
35+
"""
36+
37+
parser = argparse.ArgumentParser(description='Tool: payload-gen-qc')
38+
parser.add_argument('-i', '--input-file', dest='input_file', type=str,
39+
help='Input file', required=True)
40+
parser.add_argument('-o', '--output-dir', dest='output_dir', type=str,
41+
help='Output directory', required=True)
42+
args = parser.parse_args()
43+
44+
if not os.path.isfile(args.input_file):
45+
sys.exit('Error: specified input file %s does not exist or is not accessible!' % args.input_file)
46+
47+
if not os.path.isdir(args.output_dir):
48+
sys.exit('Error: specified output dir %s does not exist or is not accessible!' % args.output_dir)
49+
50+
subprocess.run(f"cp {args.input_file} {args.output_dir}/", shell=True, check=True)
51+
52+
53+
if __name__ == "__main__":
54+
main()
55+

‎payload-gen-qc/nextflow.config‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
docker {
2+
enabled = true
3+
runOptions = '-u \$(id -u):\$(id -g)'
4+
}

‎payload-gen-qc/pkg.json‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{
2+
"name": "payload-gen-qc",
3+
"version": "0.1.0",
4+
"description": "payload generation tool ",
5+
"main": "main.nf",
6+
"deprecated": false,
7+
"keywords": [
8+
"qc",
9+
"payload"
10+
],
11+
"repository": {
12+
"type": "git",
13+
"url": "https://github.com/icgc-argo-workflows/data-processing-utility-tools.git"
14+
},
15+
"container": {
16+
"registries": [
17+
{
18+
"registry": "ghcr.io",
19+
"type": "docker",
20+
"org": "icgc-argo-workflows",
21+
"default": true
22+
}
23+
]
24+
},
25+
"dependencies": [],
26+
"devDependencies": [],
27+
"contributors": [
28+
{
29+
"name": "Linda Xiang",
30+
"email": "linda.xiang@oicr.on.ca"
31+
}
32+
],
33+
"license": "GNU Affero General Public License v3",
34+
"bugReport": "https://github.com/icgc-argo-workflows/data-processing-utility-tools/issues",
35+
"homepage": "https://github.com/icgc-argo-workflows/data-processing-utility-tools#readme"
36+
}

‎payload-gen-qc/tests/checker.nf‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
#!/usr/bin/env nextflow
2+
3+
/*
4+
Copyright (C) 2021, Ontario Institute for Cancer Research
5+
6+
This program is free software: you can redistribute it and/or modify
7+
it under the terms of the GNU Affero General Public License as published by
8+
the Free Software Foundation, either version 3 of the License, or
9+
(at your option) any later version.
10+
11+
This program is distributed in the hope that it will be useful,
12+
but WITHOUT ANY WARRANTY; without even the implied warranty of
13+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14+
GNU Affero General Public License for more details.
15+
16+
You should have received a copy of the GNU Affero General Public License
17+
along with this program. If not, see <http://www.gnu.org/licenses/>.
18+
19+
Authors:
20+
Linda Xiang
21+
*/
22+
23+
/*
24+
This is an auto-generated checker workflow to test the generated main template workflow, it's
25+
meant to illustrate how testing works. Please update to suit your own needs.
26+
*/
27+
28+
/********************************************************************/
29+
/* this block is auto-generated based on info from pkg.json where */
30+
/* changes can be made if needed, do NOT modify this block manually */
31+
nextflow.enable.dsl = 2
32+
version = '0.1.0' // package version
33+
34+
container = [
35+
'ghcr.io': 'ghcr.io/icgc-argo-workflows/data-processing-utility-tools.payload-gen-qc'
36+
]
37+
default_container_registry = 'ghcr.io'
38+
/********************************************************************/
39+
40+
// universal params
41+
params.container_registry = ""
42+
params.container_version = ""
43+
params.container = ""
44+
45+
// tool specific parmas go here, add / change as needed
46+
params.input_file = ""
47+
params.expected_output = ""
48+
49+
include { payloadGenQc } from '../main'
50+
51+
52+
process file_smart_diff {
53+
container "${params.container ?: container[params.container_registry ?: default_container_registry]}:${params.container_version ?: version}"
54+
55+
input:
56+
path output_file
57+
path expected_file
58+
59+
output:
60+
stdout()
61+
62+
script:
63+
"""
64+
# Note: this is only for demo purpose, please write your own 'diff' according to your own needs.
65+
# in this example, we need to remove date field before comparison eg, <div id="header_filename">Tue 19 Jan 2021<br/>test_rg_3.bam</div>
66+
# sed -e 's#"header_filename">.*<br/>test_rg_3.bam#"header_filename"><br/>test_rg_3.bam</div>#'
67+
68+
cat ${output_file[0]} \
69+
| sed -e 's#"header_filename">.*<br/>#"header_filename"><br/>#' > normalized_output
70+
71+
([[ '${expected_file}' == *.gz ]] && gunzip -c ${expected_file} || cat ${expected_file}) \
72+
| sed -e 's#"header_filename">.*<br/>#"header_filename"><br/>#' > normalized_expected
73+
74+
diff normalized_output normalized_expected \
75+
&& ( echo "Test PASSED" && exit 0 ) || ( echo "Test FAILED, output file mismatch." && exit 1 )
76+
"""
77+
}
78+
79+
80+
workflow checker {
81+
take:
82+
input_file
83+
expected_output
84+
85+
main:
86+
payloadGenQc(
87+
input_file
88+
)
89+
90+
file_smart_diff(
91+
payloadGenQc.out.output_file,
92+
expected_output
93+
)
94+
}
95+
96+
97+
workflow {
98+
checker(
99+
file(params.input_file),
100+
file(params.expected_output)
101+
)
102+
}

‎payload-gen-qc/tests/expected/expected.test_rg_3.bam‎

14.6 KB
Binary file not shown.

‎payload-gen-qc/tests/expected/expected.test_rg_3_fastqc.out.gz‎

148 KB
Binary file not shown.

‎payload-gen-qc/tests/input/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This folder contains tiny data files for testing.

0 commit comments

Comments
 (0)