×

nf-core/bcftools/pluginscatter @ 0.0.0-6c4ed3a

Split VCF by chunks or regions, creating multiple VCFs.

Latest version: 0.0.0-6c4ed3a
Total downloads: 6
Source: nf-core/modules
Authors: @nvnieuwk
Maintainers: @nvnieuwk

Summary

Split VCF by chunks or regions, creating multiple VCFs.

Get started

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

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

License

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-6c4ed3a
Commit ID 6c4ed3a220310b905a1fc9d04f05be2e0837142b
Release Date 23 Apr 2026 15:05:08 (UTC)
Download URL https://registry.nextflow.io/api/v1/modules/nf-core%2Fbcftools%2Fpluginscatter/0.0.0-6c4ed3a/download
OCI Store URL https://public.cr.seqera.io/v2/nextflow/plugin/modules/nf-core/bcftools/pluginscatter/blobs/sha256:ad1bff520177fe5380031ab6c12675e894878e6b73a23dbe290890a96ee85431
Size 4.7 KB
Checksum sha256:ad1bff520177fe5380031ab6c12675e894878e6b73a23dbe290890a96ee85431
Downloads 3
Version Date Status Downloads Size
0.0.0-6c4ed3a 23 Apr 2026 15:05:08 (UTC)