nf-core_modules/modules/biscuit/pileup/meta.yml
Nathan Spix 801240a971
Add core Biscuit tools (#1354)
* create files with nf-core command

* update meta.yml files

* starting to work on index main.nf

* prelim test for index

* index test working; not finding all output files

* index passing tests

* index and align passing tests

* prototyping biscuitblaster and pileup

* update containers

* updates to pileup

* pileup passing tests

* template creation for more biscuit tools

* tests passing on blaster,bsconv,pupsom

* epiread passing tests, but need to update SNP bed file path

* vcf2bed working; change test file

* all biscuit commands passing tests

* biscuitblaster rename

* try to fix permissions

* more permission fixes

* trying a couple more permission changes

* hopefully last permission fixes

* really last permission changes

* few more permissions

* add when blocks

* Remove read group meta

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* remove read group meta

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* changes for first round of review

* update meta.yml with more specific links

* Update modules/biscuit/biscuitblaster/main.nf

Co-authored-by: Sateesh Peri <33637490+sateeshperi@users.noreply.github.com>

* Apply new version reporting

Co-authored-by: Sateesh Peri <33637490+sateeshperi@users.noreply.github.com>

* Update modules/biscuit/pileup/main.nf

Co-authored-by: Sateesh Peri <33637490+sateeshperi@users.noreply.github.com>

* Update main.nf

* Update modules/biscuit/pileupsomatic/main.nf

Co-authored-by: Sateesh Peri <33637490+sateeshperi@users.noreply.github.com>

* update test file path

* Update modules/biscuit/align/main.nf

Co-authored-by: Sateesh Peri <33637490+sateeshperi@users.noreply.github.com>

* Update modules/biscuit/align/main.nf

Co-authored-by: Sateesh Peri <33637490+sateeshperi@users.noreply.github.com>

* tests passing again

* Update modules/biscuit/align/main.nf

* Update modules/biscuit/bsconv/main.nf

* Update modules/biscuit/epiread/main.nf

* Update modules/biscuit/index/main.nf

* Update test.yml

* Update modules/biscuit/pileupsomatic/main.nf

* remove module-specific extension/prefix

* remove module-specific extension/prefix

* add missing args

* switch pileup strategy

* update test.yml

* remove debug

* whitespace cleanup

* add in newline escapes

* requested changes

* Update modules/biscuit/pileup/meta.yml

Co-authored-by: Spix <nathan.spix@submit.cm.cluster>
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: Sateesh Peri <33637490+sateeshperi@users.noreply.github.com>
Co-authored-by: Spix <nathan.spix@node107.cm.cluster>
Co-authored-by: njspix <nathan.spix@vai.org>
2022-03-14 09:34:22 -04:00

70 lines
2.4 KiB
YAML

name: biscuit_pileup
description: Computes cytosine methylation and callable SNV mutations, optionally in reference to a germline BAM to call somatic variants
keywords:
- bisulfite
- DNA methylation
- pileup
- variant calling
- WGBS
- scWGBS
- bam
- vcf
tools:
- biscuit:
description: A utility for analyzing sodium bisulfite conversion-based DNA methylation/modification data
homepage: https://huishenlab.github.io/biscuit/
documentation: https://huishenlab.github.io/biscuit/docs/pileup.html
tool_dev_url: https://github.com/huishenlab/biscuit
doi: ""
licence: ["MIT"]
input:
- meta:
type: map
description: |
Groovy Map containing sample information
e.g. [ id:'test', single_end:false ]
- normal_bams:
type: file(s)
description: |
BAM files to be analyzed. If no tumor_bam file is provided, any number of "normal" BAMs may be provided
("normal" here is just a semantic issue, these BAMs could be from tumor or any other kind of tissue). If a
tumor BAM file is provided, exactly one normal (germline) BAM must be provided.
pattern: "*.{bam}"
- normal_bais:
type: file(s)
description: BAM index file or files corresponding to the provided normal_bams
pattern: "*.{bai}"
- tumor_bam:
type: file(s)
description: |
Optional. If a tumor BAM file is provided, pileup will run in "somatic" mode and will annotate variants with
their somatic state (present in tumor only, present in normal only, present in both, etc). Note that if a
tumor BAM file is provided, exactly one normal BAM must be provided.
pattern: "*.{bam}"
- tumor_bai:
type: file(s)
description: Optional. BAM index file corresponding to provided tumor_bam
pattern: "*.{bai}"
- index:
type: dir
description: Biscuit genome index directory (generated with 'biscuit index')
pattern: "BiscuitIndex"
output:
- meta:
type: map
description: |
Groovy Map containing sample information
e.g. [ id:'test', single_end:false ]
- versions:
type: file
description: File containing software versions
pattern: "versions.yml"
- vcf:
type: file
description: vcf file with methylation information
pattern: "*.{vcf.gz}"
authors:
- "@njspix"