tbprofiler

Tags: mycobacterium-tuberculosis resistance lineage typing tb bactopia-tool

Detection of antimicrobial resistance and lineage typing of Mycobacterium tuberculosis.

This Bactopia Tool uses TBProfiler to profile Mycobacterium tuberculosis genomes for resistance mutations and strain typing. The workflow processes sequencing reads to identify resistance-conferring variants and determine the lineage of each TB isolate.

Usage

Bactopia CLI:

bactopia --wf tbprofiler \
  --bactopia /path/to/your/bactopia/results

Nextflow:

nextflow run bactopia/bactopia/workflows/bactopia-tools/tbprofiler/main.nf \
  --bactopia /path/to/your/bactopia/results

Outputs

Expected Output Files

<BACTOPIA_DIR>
├── <SAMPLE_NAME>
│   └── tools
│       └── tbprofiler-<TIMESTAMP>
│           ├── <SAMPLE_NAME>.csv
│           ├── <SAMPLE_NAME>.results.json.gz
│           ├── <SAMPLE_NAME>.txt
│           ├── logs
│           │   ├── nf.command.{begin,err,log,out,run,sh,trace}
│           │   └── versions.yml
│           └── supplemental
│               ├── <SAMPLE_NAME>.bam
│               ├── <SAMPLE_NAME>.bam.bai
│               └── <SAMPLE_NAME>.targets.vcf.gz
└── bactopia-runs
    └── tbprofiler-<TIMESTAMP>
        ├── merged-results
        │   ├── logs
        │   │   └── tbprofiler-collate
        │   │       ├── nf.command.{begin,err,log,out,run,sh,trace}
        │   │       └── versions.yml
        │   ├── tbprofiler.csv
        │   ├── tbprofiler.variants.csv
        │   └── tbprofiler.variants.txt
        └── nf-reports
            ├── tbprofiler-dag.dot
            ├── tbprofiler-report.html
            └── tbprofiler-timeline.html

Per-Sample Results

File	Description
*.results.txt	Text file containing TBProfiler resistance and strain typing results
*.results.json	JSON file containing detailed TBProfiler analysis results
*.results.csv	CSV file containing TBProfiler results in tabular format
bam/*.bam	BAM file with read alignment details against reference genomes
vcf/*.targets.csq.vcf.gz	VCF file with variant annotations and functional consequences

Merged Results

File	Description
tbprofiler.tsv	Merged TSV file containing TBProfiler results from all samples

Audit Trail

Below are files that can assist you in understanding which parameters and program versions were used.

Logs

Each process that is executed will have a folder named logs. In this folder are helpful files for you to review if the need ever arises.

Extension	Description
.begin	An empty file used to designate the process started
.err	Contains STDERR outputs from the process
.log	Contains both STDERR and STDOUT outputs from the process
.out	Contains STDOUT outputs from the process
.run	The script Nextflow uses to stage/unstage files and queue processes based on given profile
.sh	The script executed by bash for the process
.trace	The Nextflow trace report for the process
versions.yml	A YAML formatted file with program versions

Nextflow Reports

These Nextflow reports provide great a great summary of your run. These can be used to optimize resource usage and estimate expected costs if using cloud platforms.

Filename	Description
tbprofiler-dag.dot	The Nextflow DAG visualization
tbprofiler-report.html	The Nextflow Execution Report
tbprofiler-timeline.html	The Nextflow Timeline Report
tbprofiler-trace.txt	The Nextflow Trace report

Parameters

Required Parameters

Define where the pipeline should find input data and save output data.

Parameter	Type	Default	Description
--bactopia	string		The path to bactopia results to use as inputs

TB-Profiler Profile Parameters

Parameter	Type	Default	Description
--tbprofiler_call_whole_genome	boolean	false	Call whole genome
--tbprofiler_mapper	string	bwa	Mapping tool to use. If you are using nanopore data it will default to minimap2 (choices: bwa, minimap2, bowtie2, bwa-mem2)
--tbprofiler_caller	string	freebayes	Variant calling tool to use (choices: bcftools, gatk, freebayes)
--tbprofiler_calling_params	string		Extra variant caller options in quotes
--tbprofiler_suspect	boolean	false	Use the suspect suite of tools to add ML predictions
--tbprofiler_no_flagstat	boolean	false	Don't collect flagstats
--tbprofiler_no_delly	boolean	false	Don't run delly
--tbprofiler_opts	string		Extra options in quotes for TBProfiler

TB-Profiler Collate Parameters

Parameter	Type	Default	Description
--tbprofiler_itol	boolean	false	Generate itol config files
--tbprofiler_full	boolean	false	Output mutations in main result file
--tbprofiler_all_variants	boolean	false	Output all variants in variant matrix
--tbprofiler_mark_missing	boolean	false	An asterisk will be used to mark predictions which are affected by missing data at a drug resistance position

Filtering Parameters

Use these parameters to specify which samples to include or exclude.

Parameter	Type	Default	Description
--include	string		A text file containing sample names (one per line) to include from the analysis
--exclude	string		A text file containing sample names (one per line) to exclude from the analysis

Optional Parameters

These optional parameters can be useful in certain settings.

Parameter	Type	Default	Description
--outdir	string	bactopia	Base directory to write results to
--skip_compression	boolean	false	Output files will not be compressed
--datasets	string		The path to cache datasets to
--keep_all_files	boolean	false	Keeps all analysis files created

Max Job Request Parameters

Set the top limit for requested resources for any single job.

Parameter	Type	Default	Description
--max_retry	integer	3	Maximum times to retry a process before allowing it to fail.
--max_cpus	integer	4	Maximum number of CPUs that can be requested for any single job.
--max_memory	string	128.GB	Maximum amount of memory that can be requested for any single job.
--max_time	string	240.h	Maximum amount of time that can be requested for any single job.
--max_downloads	integer	3	Maximum number of samples to download at a time

Nextflow Configuration Parameters

Parameters to fine-tune your Nextflow setup.

Parameter	Type	Default	Description
--nfconfig	string		A Nextflow compatible config file for custom profiles, loaded last and will overwrite existing variables if set.
--publish_dir_mode	string	copy	Method used to save pipeline results to output directory. (choices: symlink, rellink, link, copy, copyNoFollow, move)
--infodir	string	${params.outdir}/pipeline_info	Directory to keep pipeline Nextflow logs and reports.
--force	boolean	false	Nextflow will overwrite existing output files.
--cleanup_workdir	boolean	false	After Bactopia is successfully executed, the work directory will be deleted.

Institutional config options

Parameters used to describe centralized config profiles. These should not be edited.

Parameter	Type	Default	Description
--custom_config_version	string	master	Git commit id for Institutional configs.
--custom_config_base	string	https://raw.githubusercontent.com/nf-core/configs/master	Base directory for Institutional configs.
--config_profile_name	string		Institutional config name.
--config_profile_description	string		Institutional config description.
--config_profile_contact	string		Institutional config contact information.
--config_profile_url	string		Institutional config URL link.

Nextflow Profile Parameters

Parameters to fine-tune your Nextflow setup.

Parameter	Type	Default	Description
--condadir	string		Directory to Nextflow should use for Conda environments
--registry	string	quay.io	Registry to pull Docker containers from.
--datasets_cache	string	<HOME>/.bactopia/datasets	Directory where downloaded datasets should be stored.
--singularity_cache	string		Directory where remote Singularity images are stored.
--singularity_pull_docker_container	boolean		Instead of directly downloading Singularity images for use with Singularity, force the workflow to pull and convert Docker containers instead.
--force_rebuild	boolean	false	Force overwrite of existing pre-built environments.
--queue	string	general,high-memory	Comma-separated name of the queue(s) to be used by a job scheduler (e.g. AWS Batch or SLURM)
--cluster_opts	string		Additional options to pass to the executor. (e.g. SLURM: '--account=my_acct_name'
--container_opts	string		Additional options to pass to Apptainer, Docker, or Singularity. (e.g. Singularity: '-D pwd'
--disable_scratch	boolean	false	All intermediate files created on worker nodes of will be transferred to the head node.

Helpful Parameters

Uncommonly used parameters that might be useful.

Parameter	Type	Default	Description
--monochrome_logs	boolean		Do not use coloured log outputs.
--nfdir	boolean		Print directory Nextflow has pulled Bactopia to
--sleep_time	integer	5	The amount of time (seconds) Nextflow will wait after setting up datasets before execution.
--validate_params	boolean	true	Boolean whether to validate parameters against the schema at runtime
--help	boolean		Display help text.
--wf	string	bactopia	Specify which workflow or Bactopia Tool to execute
--list_wfs	boolean		List the available workflows and Bactopia Tools to use with '--wf'
--show_hidden_params	boolean		Show all params when using --help
--help_all	boolean		An alias for --help --show_hidden_params
--version	boolean		Display version text.

Composition

This workflow uses the following subworkflows:

• tbprofiler - Profiling tool for Mycobacterium tuberculosis to detect resistance and strain type.

Citations

If you use this in your analysis, please cite the following.

• Bactopia
  Petit III RA, Read TD Bactopia - a flexible pipeline for complete analysis of bacterial genomes. mSystems 5 (2020)

• TBProfiler
  Phelan JE, O'Sullivan DM, Machado D, Ramos J, Oppong YEA, Campino S, O'Grady J, McNerney R, Hibberd ML, Viveiros M, Huggett JF, Clark TG Integrating informatics tools and portable sequencing technology for rapid detection of resistance to anti-tuberculous drugs. Genome Med 11, 41 (2019)

Source

View source on GitHub