×

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

Split VCF by sample, creating single- or multi-sample VCFs.

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

Summary

Split VCF by sample, creating single- or multi-sample VCFs.

Get started

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

include { BCFTOOLS_PLUGINSPLIT } from 'nf-core/bcftools/pluginsplit'

License

MIT License

Process
Name BCFTOOLS_PLUGINSPLIT
Input 1 channel
#1 tuple
meta map

Groovy Map containing sample information e.g. [ id:'test', single_end:false ]

vcf file

The VCF file to split

*.{vcf,vcf.gz,bcf,bcf.gz}
tbi file

OPTIONAL - The index of the input VCF/BCF

*.tbi
samples file

A tab-separated file determining which samples should be in which output file column 1: The sample name(s) in the input file column 2: The sample name(s) to use in the output file (use - to keep the original name) column 3: The name of the output file Either this or a groups file should be given

*
groups file

A tab-separated file determining which samples should be in which output file(s) column 1: The sample name(s) in the input file column 2: The sample name(s) to use in the output file (use - to keep the original name) column 3: The name of the output file(s) Either this or a samples file should be given

*
regions file

A BED file containing regions to use

*.bed
targets file

A BED file containing regions to use (but streams rather than index-jumps)

*.bed
Output 4 channels
#1 csi tuple
meta map

Groovy Map containing sample information e.g. [ id:'test', single_end:false ]

*.csi file

CSI file

*.csi
#2 tbi tuple
meta map

Groovy Map containing sample information e.g. [ id:'test', single_end:false ]

*.tbi file

TBI file

*.tbi
#3 vcf tuple
meta map

Groovy Map containing sample information e.g. [ id:'test', single_end:false ]

*.{vcf,vcf.gz,bcf,bcf.gz} file

The resulting VCF files from the split

*.{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
pluginsplit Split VCF by sample, creating single- or multi-sample VCFs. http://samtools.github.io/bcftools/bcftools.html
Version 0.0.0-6c4ed3a
Commit ID 6c4ed3a220310b905a1fc9d04f05be2e0837142b
Release Date 23 Apr 2026 15:05:10 (UTC)
Download URL https://registry.nextflow.io/api/v1/modules/nf-core%2Fbcftools%2Fpluginsplit/0.0.0-6c4ed3a/download
OCI Store URL https://public.cr.seqera.io/v2/nextflow/plugin/modules/nf-core/bcftools/pluginsplit/blobs/sha256:3d233a6b958b44255da667231c94553ee743ee51ef2c3cb2c1f2439fb399e14b
Size 3.9 KB
Checksum sha256:3d233a6b958b44255da667231c94553ee743ee51ef2c3cb2c1f2439fb399e14b
Downloads 3
Version Date Status Downloads Size
0.0.0-6c4ed3a 23 Apr 2026 15:05:10 (UTC) 3 3.9 KB
0.0.0-0c7146d 08 Apr 2026 18:46:14 (UTC) 4 3.9 KB