Nextflow Registry | nf-core/bcftools/pluginscatter@0.0.0-0c7146d

nf-core/bcftools/pluginscatter @ 0.0.0-0c7146d

Split VCF by chunks or regions, creating multiple VCFs.

scatter vcf bcf genomics

Latest version: 0.0.0-0c7146d

Total downloads: 1

Source: nf-core/modules

Authors: @nvnieuwk

Maintainers: @nvnieuwk

Split VCF by chunks or regions, creating multiple VCFs.

Add the following snippet to your workflow script to include this module.

include { BCFTOOLS_PLUGINSCATTER } from 'nf-core/bcftools/pluginscatter'

MIT License

Process

`Name`	`BCFTOOLS_PLUGINSCATTER`

Input 6 channels

#1 tuple

`meta` map	Groovy Map containing sample information e.g. [ id:'test', single_end:false ]
`vcf` file	The input VCF to scatter `*.{vcf,vcf.gz,bcf,bcf.gz}`
`tbi` file	Optional index of the input VCF `*.tbi`

`sites_per_chunk` integer	How many variants should be in each output file Either this or `scatter` or `scatter_file` have to be given

`scatter` string	A comma delimited list of regions to scatter into Either this or `sites_per_chunk` or `scatter_file` have to be given

`scatter_file` file	A file containing a region on each line with an optional second column containing the filename Either this or `sites_per_chunk` or `scatter` have to be given

`regions` file	Optional file containing the regions to work on `*.bed`

`targets` file	Optional file containing the regions to work on (but streams instead of index-jumping) `*.bed`

Output 4 channels

#1 csi tuple

`meta` map	Groovy Map containing sample information e.g. [ id:'test', single_end:false ]
`*.csi` file	Default VCF file index `*.csi`

#2 tbi tuple

`meta` map	Groovy Map containing sample information e.g. [ id:'test', single_end:false ]
`*.tbi` file	Alternative VCF file index `*.tbi`

#3 scatter tuple

`meta` map	Groovy Map containing sample information e.g. [ id:'test', single_end:false ]
`*{vcf,vcf.gz,bcf,bcf.gz}` file	The resulting files of the scattering `*.{vcf,vcf.gz,bcf,bcf.gz}`

#4 versions_bcftools tuple

`${task.process}` string	The process the versions were collected from
`bcftools` string	The tool name
`bcftools --version \| sed '1!d; s/^.*bcftools //'` string	The command used to generate the version of the tool

Tool	Description	Homepage
pluginscatter	Split VCF by chunks or regions, creating multiple VCFs.	http://samtools.github.io/bcftools/bcftools.html

Version	0.0.0-0c7146d
Commit ID	135d883a43b1a2324b4112cd270cf22e20835533
Release Date	08 Apr 2026 18:25:28 (UTC)
Download URL	https://registry-stage.nextflow.io/api/v1/modules/nf-core%2Fbcftools%2Fpluginscatter/0.0.0-0c7146d/download
OCI Store URL	https://public.cr.stage-seqera.io/v2/nextflow/plugin-stage/modules/nf-core/bcftools/pluginscatter/blobs/sha256:fe8ee065efa4964734e54e1e7dafed586b27c51b2604968876f1a36d08a7aec4
Size	4.7 KB
Checksum	sha256:fe8ee065efa4964734e54e1e7dafed586b27c51b2604968876f1a36d08a7aec4
Downloads	1

Version	Date	Status	Downloads	Size	Diff
0.0.0-0c7146d	08 Apr 2026 18:25:28 (UTC)