-
Notifications
You must be signed in to change notification settings - Fork 928
feat: addition of vembrane table module #9285
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+431
−0
Merged
Changes from 2 commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
66588fc
fix: linting error
fd659e3
fix: add conda snapshot
28d37a0
fix: test path specification and removed test prefix
a3e35a2
Merge branch 'master' of https://github.com/nf-core/modules into vemb…
3dfa74b
fix: add explicit version displayed
1e91998
fix: revert the snapshot syntax
6b07b86
Merge branch 'master' of https://github.com/nf-core/modules into vemb…
e268108
fix: explicit version snapshot retry
2dae392
fix: remove newline
a3327fd
Merge branch 'master' of https://github.com/nf-core/modules into vemb…
d707a84
Update modules/nf-core/vembrane/table/tests/main.nf.test
mkatsanto 33daff0
Apply suggestions from code review
mkatsanto afcbc53
fix: apply formatting code review changes
ae3b9a1
Merge branch 'vembrane_table' of https://github.com/mkatsanto/modules…
0589efd
Update modules/nf-core/vembrane/table/main.nf
SPPearce 4d58268
Merge branch 'master' into vembrane_table
SPPearce 06fe195
Update modules/nf-core/vembrane/table/main.nf
SPPearce File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| # yaml-language-server: $schema=https://raw.githubusercontent.com/nf-core/modules/master/modules/environment-schema.json | ||
| channels: | ||
| - conda-forge | ||
| - bioconda | ||
| dependencies: | ||
| - bioconda::vembrane=2.4.0 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
|
|
||
|
|
||
SPPearce marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| process VEMBRANE_TABLE { | ||
| tag "$meta.id" | ||
| label 'process_low' | ||
|
|
||
| conda "${moduleDir}/environment.yml" | ||
| container "${ workflow.containerEngine == 'singularity' && !task.ext.singularity_pull_docker_container ? | ||
| 'https://depot.galaxyproject.org/singularity/vembrane:2.4.0--pyhdfd78af_0': | ||
| 'biocontainers/vembrane:2.4.0--pyhdfd78af_0'}" | ||
|
|
||
| input: | ||
| tuple val(meta), path(vcf) | ||
| val expression | ||
|
|
||
| output: | ||
| tuple val(meta), path("*.tsv"), emit: table | ||
| path "versions.yml" , emit: versions | ||
famosab marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| when: | ||
| task.ext.when == null || task.ext.when | ||
|
|
||
| script: | ||
| def args = task.ext.args ?: '' | ||
| def prefix = task.ext.prefix ?: "${meta.id}" | ||
| """ | ||
| vembrane table \\ | ||
| $args \\ | ||
| --output ${prefix}.tsv \\ | ||
| '$expression' \\ | ||
| $vcf | ||
| cat <<-END_VERSIONS > versions.yml | ||
| "${task.process}": | ||
| vembrane: \$(vembrane --version 2>&1 | head -n1 | sed 's/vembrane //') | ||
SPPearce marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| END_VERSIONS | ||
| """ | ||
|
|
||
| stub: | ||
| def prefix = task.ext.prefix ?: "${meta.id}" | ||
| """ | ||
| touch ${prefix}.tsv | ||
| cat <<-END_VERSIONS > versions.yml | ||
| "${task.process}": | ||
| vembrane: \$(vembrane --version 2>&1 | head -n1 | sed 's/vembrane //') | ||
SPPearce marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| END_VERSIONS | ||
| """ | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # yaml-language-server: $schema=https://raw.githubusercontent.com/nf-core/modules/master/modules/meta-schema.json | ||
| name: "vembrane_table" | ||
| description: Creates tabular (TSV) files from VCF/BCF data with flexible Python expressions | ||
| keywords: | ||
| - vcf | ||
| - bcf | ||
| - table | ||
| - genomics | ||
| - variant | ||
| - annotation | ||
| tools: | ||
| - "vembrane": | ||
| description: "Filter VCF/BCF files with Python expressions" | ||
| homepage: "https://vembrane.github.io/" | ||
| documentation: "https://github.com/vembrane/vembrane/blob/main/docs/table.md" | ||
| tool_dev_url: "https://github.com/vembrane/vembrane" | ||
| doi: "10.1093/bioinformatics/btac810" | ||
| licence: ["MIT"] | ||
| identifier: biotools:vembrane | ||
| args_id: "$args" | ||
|
|
||
| input: | ||
| - - meta: | ||
| type: map | ||
| description: | | ||
| Groovy Map containing sample information | ||
| e.g. `[ id:'sample1', single_end:false ]` | ||
| - vcf: | ||
| type: file | ||
| description: VCF/BCF file to extract tabular data from | ||
| pattern: "*.{vcf,vcf.gz,bcf,bcf.gz}" | ||
| ontologies: | ||
| - edam: http://edamontology.org/format_3016 # VCF | ||
| - expression: | ||
| type: string | ||
| description: A comma-separated tuple of expressions that define the table column contents | ||
|
|
||
| output: | ||
| table: | ||
| - - meta: | ||
| type: map | ||
| description: | | ||
| Groovy Map containing sample information | ||
| e.g. `[ id:'sample1', single_end:false ]` | ||
| - "*.tsv": | ||
| type: file | ||
| description: TSV file containing tabular data from VCF/BCF | ||
| pattern: "*.tsv" | ||
| ontologies: | ||
| - edam: http://edamontology.org/format_3475 # TSV | ||
| versions: | ||
| - versions.yml: | ||
| type: file | ||
| description: File containing software versions | ||
| pattern: "versions.yml" | ||
| ontologies: | ||
| - edam: http://edamontology.org/format_3750 # YAML | ||
| authors: | ||
| - "@mkatsanto" | ||
| - "@trangdo-hsc" | ||
| maintainers: | ||
| - "@mkatsanto" | ||
| - "@trangdo-hsc" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
|
|
||
mkatsanto marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| nextflow_process { | ||
|
|
||
| name "Test Process VEMBRANE_TABLE" | ||
| script "../main.nf" | ||
| process "VEMBRANE_TABLE" | ||
|
|
||
| tag "modules" | ||
| tag "modules_nfcore" | ||
| tag "vembrane" | ||
| tag "vembrane/table" | ||
|
|
||
| test("homo_sapiens - [vcf] - tsv") { | ||
|
|
||
| when { | ||
| process { | ||
| """ | ||
| input[0] = [ | ||
| [ id:'test', single_end:false ], // meta map | ||
mkatsanto marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| file(params.test_data['homo_sapiens']['illumina']['test_rnaseq_vcf'], checkIfExists: true) | ||
SPPearce marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ] | ||
| input[1] = 'CHROM, POS, REF, ALT, QUAL' | ||
| """ | ||
| } | ||
| } | ||
|
|
||
| then { | ||
| assertAll( | ||
| { assert process.success }, | ||
| { assert snapshot(process.out).match() } | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| test("homo_sapiens - [bcf.gz] - tsv") { | ||
|
|
||
| when { | ||
| process { | ||
| """ | ||
| input[0] = [ | ||
| [ id:'test', single_end:false ], // meta map | ||
mkatsanto marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| file(params.test_data['homo_sapiens']['popgen']['plink_case_control_bcf_gz'], checkIfExists: true) | ||
| ] | ||
| input[1] = 'CHROM, POS, REF, ALT, QUAL' | ||
| """ | ||
| } | ||
| } | ||
|
|
||
| then { | ||
| assertAll( | ||
| { assert process.success }, | ||
| { assert snapshot(process.out).match() } | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| test("homo_sapiens - [vcf] - csv - custom_separator") { | ||
|
|
||
| config "./nextflow.config" | ||
|
|
||
| when { | ||
| params { | ||
| vembrane_args = '--separator ,' | ||
| vembrane_prefix = 'test.csv' | ||
| } | ||
| process { | ||
| """ | ||
| input[0] = [ | ||
| [ id:'test', single_end:false ], // meta map | ||
mkatsanto marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| file(params.test_data['homo_sapiens']['illumina']['test_rnaseq_vcf'], checkIfExists: true) | ||
| ] | ||
| input[1] = 'CHROM, POS, REF, ALT' | ||
| """ | ||
| } | ||
| } | ||
|
|
||
| then { | ||
| assertAll( | ||
| { assert process.success }, | ||
| { assert snapshot(process.out).match() } | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| test("homo_sapiens - [vcf] - tsv - custom_header") { | ||
|
|
||
| config "./nextflow.config" | ||
|
|
||
| when { | ||
| params { | ||
| vembrane_args = '--header "Chromosome,Position,Variant_ID,Quality"' | ||
| vembrane_prefix = 'test.custom_header' | ||
| } | ||
| process { | ||
| """ | ||
| input[0] = [ | ||
| [ id:'test', single_end:false ], // meta map | ||
mkatsanto marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| file(params.test_data['homo_sapiens']['illumina']['test_rnaseq_vcf'], checkIfExists: true) | ||
| ] | ||
| input[1] = 'CHROM, POS, ID, QUAL' | ||
| """ | ||
| } | ||
| } | ||
|
|
||
| then { | ||
| assertAll( | ||
| { assert process.success }, | ||
| { assert snapshot(process.out).match() } | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| test("homo_sapiens - [vcf] - tsv - stub") { | ||
|
|
||
| options "-stub" | ||
|
|
||
| when { | ||
| process { | ||
| """ | ||
| input[0] = [ | ||
| [ id:'test', single_end:false ], // meta map | ||
mkatsanto marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| file(params.test_data['homo_sapiens']['illumina']['test_rnaseq_vcf'], checkIfExists: true) | ||
| ] | ||
| input[1] = 'CHROM, POS, REF, ALT, QUAL' | ||
| """ | ||
| } | ||
| } | ||
|
|
||
| then { | ||
| assertAll( | ||
| { assert process.success }, | ||
| { assert snapshot(process.out).match() } | ||
SPPearce marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ) | ||
| } | ||
| } | ||
|
|
||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.