×

nf-core/tmb/pytmb @ 0.0.0-6c4ed3a

This module calculates Tumor Mutational Burden (TMB) scores from VCF files using the pyTMB tool.

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

Summary

This module calculates Tumor Mutational Burden (TMB) scores from VCF files using the pyTMB tool.

Get started

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

include { TMB_PYTMB } from 'nf-core/tmb/pytmb'

License

MIT License

Process
Name TMB_PYTMB
Input 1 channel
#1 tuple
meta map

Groovy Map containing sample information e.g. [ id:'sample1' ]

vcf file

Annotated VCF file.

*.vcf
bed file

BED file defining the target regions. Required if eff_genome_size is not provided.

*.bed
eff_genome_size string

Effective genome size (in bases). Required if bed is not provided.

var_config file

YAML file defining variant annotation parsing rules. See example here.

*.yml
db_config file

YAML file defining the database configuration for variant annotations. See example here.

*.yml
Output 4 channels
#1 tmb_log tuple
meta map

Groovy Map containing sample information e.g. [ id:'sample1' ]

*.log file

Log file containing TMB calculation details

#2 debug_vcf tuple
meta map

Groovy Map containing sample information e.g. [ id:'sample1' ]

*_debug.vcf.gz file

Debug VCF file containing detailed TMB calculation information

*_debug.vcf.gz
#3 export_vcf tuple
meta map

Groovy Map containing sample information e.g. [ id:'sample1' ]

*_export.vcf.gz file

Export VCF file containing TMB annotations

*_export.vcf.gz
#4 versions_tmb tuple
${task.process} string

The name of the process

tmb string

The name of the tool

pyTMB.py --version | awk '{print \$2}' | tr -d '()' eval

The expression to obtain the version of the tool

Tool Description Homepage
tmb This tool was designed to calculate a Tumor Mutational Burden (TMB) score from a VCF file. https://github.com/bioinfo-pf-curie/TMB/blob/v1.5.0/README.md
Version 0.0.0-6c4ed3a
Commit ID 6c4ed3a220310b905a1fc9d04f05be2e0837142b
Release Date 23 Apr 2026 15:49:56 (UTC)
Download URL https://registry.nextflow.io/api/v1/modules/nf-core%2Ftmb%2Fpytmb/0.0.0-6c4ed3a/download
OCI Store URL https://public.cr.seqera.io/v2/nextflow/plugin/modules/nf-core/tmb/pytmb/blobs/sha256:c53268cae8ce9b3482055e8cb3169cb40329127d1e5e8ced1ff1176a47eca0b2
Size 3.4 KB
Checksum sha256:c53268cae8ce9b3482055e8cb3169cb40329127d1e5e8ced1ff1176a47eca0b2
Downloads 3
Version Date Status Downloads Size
0.0.0-6c4ed3a 23 Apr 2026 15:49:56 (UTC) 3 3.4 KB
0.0.0-0c7146d 08 Apr 2026 19:43:52 (UTC) 3 3.4 KB