diff --git a/modules/nf-core/civicpy/annotate/environment.yml b/modules/nf-core/civicpy/annotate/environment.yml new file mode 100644 index 00000000000..44d06b899ca --- /dev/null +++ b/modules/nf-core/civicpy/annotate/environment.yml @@ -0,0 +1,8 @@ +--- +# yaml-language-server: $schema=https://raw.githubusercontent.com/nf-core/modules/master/modules/environment-schema.json +channels: + - conda-forge + - bioconda + - nodefaults +dependencies: + - "bioconda::civicpy=5.2.0" diff --git a/modules/nf-core/civicpy/annotate/main.nf b/modules/nf-core/civicpy/annotate/main.nf new file mode 100644 index 00000000000..4574e80c127 --- /dev/null +++ b/modules/nf-core/civicpy/annotate/main.nf @@ -0,0 +1,42 @@ +process CIVICPY_ANNOTATE { + tag "${meta.id}" + label 'process_single' + + conda "${moduleDir}/environment.yml" + container "${workflow.containerEngine == 'singularity' && !task.ext.singularity_pull_docker_container + ? 'https://depot.galaxyproject.org/singularity/civicpy:5.2.0--pyhdfd78af_0' + : 'docker.io/griffithlab/civicpy:v5.2.0' }" + + input: + tuple val(meta), path(vcf), path(tbi) + val annotation_genome_version + + output: + tuple val(meta), path("*.vcf"), emit: vcf + tuple val("${task.process}"), val('civicpy'), eval("civicpy --version | sed 's/.*version //'"), topic: versions, emit: versions_civicpy + + when: + task.ext.when == null || task.ext.when + + script: + def args = task.ext.args ?: '' + def prefix = task.ext.prefix ?: "${meta.id}.civic" + + """ + export CIVICPY_CACHE_FILE=\$PWD/.civicpy + + civicpy annotate-vcf \\ + --input-vcf ${vcf} \\ + --output-vcf ${prefix}.vcf \\ + --reference ${annotation_genome_version} \\ + ${args} + """ + + stub: + def args = task.ext.args ?: '' + def prefix = task.ext.prefix ?: "${meta.id}.civic" + + """ + touch ${prefix}.vcf + """ +} diff --git a/modules/nf-core/civicpy/annotate/meta.yml b/modules/nf-core/civicpy/annotate/meta.yml new file mode 100644 index 00000000000..8ab945fcbf7 --- /dev/null +++ b/modules/nf-core/civicpy/annotate/meta.yml @@ -0,0 +1,69 @@ +--- +# yaml-language-server: $schema=https://raw.githubusercontent.com/nf-core/modules/master/modules/meta-schema.json +name: "civicpy_annotate" + +description: A python client and analysis toolkit for the Clinical Interpretations of Variants in Cancer (CIViC) knowledgebase +keywords: + - clinical interpretation + - variant annotation + - genetic variation analysis + - genomics +tools: + - "civicpy": + description: "CIViC variant knowledgebase analysis toolkit." + homepage: "https://docs.civicpy.org/en/latest/" + documentation: "https://docs.civicpy.org/en/latest/" + tool_dev_url: "https://github.com/griffithlab/civicpy" + doi: "10.1200/CCI.19.00127" + licence: ["MIT"] + identifier: biotools:CIViCpy + +input: + - - meta: + type: map + description: | + Groovy Map containing sample information + e.g. `[ id:'sample1', single_end:false ]` + + - vcf: + type: file + description: Sorted and indexed VCF file + pattern: "*.{vcf}" + ontologies: + - edam: "http://edamontology.org/format_3016" + + - tbi: + type: file + description: Tabix index for the input VCF + pattern: "*.tbi" + + - annotation_genome_version: + type: string + description: Reference genome version passed to civicpy (e.g. GRCh38) + +output: + vcf: + - - meta: + type: map + description: | + Groovy Map containing sample information + e.g. `[ id:'sample1', single_end:false ]` + - "*.vcf": + type: file + description: Annotated VCF file + pattern: "*.vcf" + ontologies: + - edam: "http://edamontology.org/format_3016" + + versions: + - versions.yml: + type: file + description: File containing software versions + pattern: "versions.yml" + ontologies: + - edam: http://edamontology.org/format_3750 # YAML + +authors: + - "@emmcauley" +maintainers: + - "@emmcauley" diff --git a/modules/nf-core/civicpy/annotate/tests/main.nf.test b/modules/nf-core/civicpy/annotate/tests/main.nf.test new file mode 100644 index 00000000000..8ddac86b877 --- /dev/null +++ b/modules/nf-core/civicpy/annotate/tests/main.nf.test @@ -0,0 +1,95 @@ +nextflow_process { + + name "Test Process CIVICPY_ANNOTATE" + script "../main.nf" + process "CIVICPY_ANNOTATE" + config "./nextflow.config" + tag "modules" + tag "modules_nfcore" + tag "civicpy" + tag "civicpy/annotate" + + test("homo_sapiens - vcf - GRCh38") { + + when { + process { + """ + input[0] = [ + [ id:'test_sample' ], + file(params.modules_testdata_base_path + 'genomics/homo_sapiens/illumina/gatk/paired_mutect2_calls/test_test2_paired_mutect2_calls.vcf.gz', checkIfExists: true), + file(params.modules_testdata_base_path + 'genomics/homo_sapiens/illumina/gatk/paired_mutect2_calls/test_test2_paired_mutect2_calls.vcf.gz.tbi', checkIfExists: true) + ] + input[1] = 'GRCh38' + """ + } + } + + then { + assertAll( + { assert process.success }, + { assert snapshot( + path(process.out.vcf[0][1]).vcf.variantsMD5, + process.out.versions_civicpy + ).match() } + ) + } + + } + + test("homo_sapiens - vcf - GRCh37") { + + when { + process { + """ + input[0] = [ + [ id:'test_sample' ], + file(params.modules_testdata_base_path + 'genomics/homo_sapiens/illumina/gatk/paired_mutect2_calls/test_test2_paired_mutect2_calls.vcf.gz', checkIfExists: true), + file(params.modules_testdata_base_path + 'genomics/homo_sapiens/illumina/gatk/paired_mutect2_calls/test_test2_paired_mutect2_calls.vcf.gz.tbi', checkIfExists: true) + ] + input[1] = 'GRCh37' + """ + } + } + + then { + assertAll( + { assert process.success }, + { assert snapshot( + path(process.out.vcf[0][1]).vcf.variantsMD5, + process.out.versions_civicpy + ).match() } + ) + } + + } + + test("homo_sapiens - vcf - GRCh38 - stub") { + + options "-stub" + + when { + process { + """ + input[0] = [ + [ id:'test_sample' ], + file(params.modules_testdata_base_path + 'genomics/homo_sapiens/illumina/gatk/paired_mutect2_calls/test_test2_paired_mutect2_calls.vcf.gz', checkIfExists: true), + file(params.modules_testdata_base_path + 'genomics/homo_sapiens/illumina/gatk/paired_mutect2_calls/test_test2_paired_mutect2_calls.vcf.gz.tbi', checkIfExists: true) + ] + input[1] = 'GRCh38' + """ + } + } + + then { + assertAll( + { assert process.success }, + { assert snapshot( + file(process.out.vcf[0][1]).name, + process.out.versions_civicpy + ).match() } + ) + } + + } + +} diff --git a/modules/nf-core/civicpy/annotate/tests/main.nf.test.snap b/modules/nf-core/civicpy/annotate/tests/main.nf.test.snap new file mode 100644 index 00000000000..55afc1df116 --- /dev/null +++ b/modules/nf-core/civicpy/annotate/tests/main.nf.test.snap @@ -0,0 +1,53 @@ +{ + "homo_sapiens - vcf - GRCh38 - stub": { + "content": [ + "test_sample.civic.vcf", + [ + [ + "CIVICPY_ANNOTATE", + "civicpy", + "5.2.0" + ] + ] + ], + "meta": { + "nf-test": "0.9.3", + "nextflow": "25.10.2" + }, + "timestamp": "2026-03-26T17:38:23.86228" + }, + "homo_sapiens - vcf - GRCh37": { + "content": [ + "bf3fe04101ac5b192de625ebf9a4324f", + [ + [ + "CIVICPY_ANNOTATE", + "civicpy", + "5.2.0" + ] + ] + ], + "meta": { + "nf-test": "0.9.3", + "nextflow": "25.10.2" + }, + "timestamp": "2026-03-27T11:16:21.699688" + }, + "homo_sapiens - vcf - GRCh38": { + "content": [ + "bf3fe04101ac5b192de625ebf9a4324f", + [ + [ + "CIVICPY_ANNOTATE", + "civicpy", + "5.2.0" + ] + ] + ], + "meta": { + "nf-test": "0.9.3", + "nextflow": "25.10.2" + }, + "timestamp": "2026-03-27T11:15:57.673023" + } +} \ No newline at end of file diff --git a/modules/nf-core/civicpy/annotate/tests/nextflow.config b/modules/nf-core/civicpy/annotate/tests/nextflow.config new file mode 100644 index 00000000000..6822afe82b3 --- /dev/null +++ b/modules/nf-core/civicpy/annotate/tests/nextflow.config @@ -0,0 +1,5 @@ +process { + withName: CIVICPY_ANNOTATE { + ext.args = '--include-status accepted' + } +}