Bactopia Tool - `tbprofiler`¶

The tbprofiler module uses TBProfiler for profiling reads to determine resistance and Mycobacterium tuberculosis strain type.

Example Usage¶

bactopia --wf tbprofiler \
  --bactopia /path/to/your/bactopia/results \ 
  --include includes.txt

Output Overview¶

Below is the default output structure for the tbprofiler tool. Where possible the file descriptions below were modified from a tools description.

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

Directory structure might be different

tbprofiler is available as a standalone Bactopia Tool, as well as from the main Bactopia workflow (e.g. through Staphopia or Merlin). If executed from Bactopia, the tbprofiler directory structure might be different, but the output descriptions below still apply.

Results¶

TBProfiler¶

Below is a description of the per-sample results from TBProfiler.

Filename	Description
<SAMPLE_NAME>.results.csv	A CSV formated `TBProfiler` result file of resistance and strain type
<SAMPLE_NAME>.results.json	A JSON formated `TBProfiler` result file of resistance and strain type
<SAMPLE_NAME>.results.txt	A text file with `TBProfiler` results
<SAMPLE_NAME>.bam	BAM file with alignment details
<SAMPLE_NAME>.targets.csq.vcf.gz	VCF with variant info again reference genomes

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 visualisation
tbprofiler-report.html	The Nextflow Execution Report
tbprofiler-timeline.html	The Nextflow Timeline Report
tbprofiler-trace.txt	The Nextflow Trace report

Program Versions¶

At the end of each run, each of the versions.yml files are merged into the files below.

Filename	Description
software_versions.yml	A complete list of programs and versions used by each process
software_versions_mqc.yml	A complete list of programs and versions formatted for MultiQC

Parameters¶

Required Parameters¶

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

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

Filtering Parameters¶

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

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

TBProfiler Parameters¶

Parameter	Description
`--call_whole_genome`	Call whole genome Type: `boolean`
`--mapper`	Mapping tool to use. If you are using nanopore data it will default to minimap2 Type: `string`, Default: `bwa`
`--caller`	Variant calling tool to use Type: `string`, Default: `freebayes`
`--calling_params`	Extra variant caller options in quotes Type: `string`
`--suspect`	Use the suspect suite of tools to add ML predictions Type: `boolean`
`--no_flagstat`	Don't collect flagstats Type: `boolean`
`--no_delly`	Don't run delly Type: `boolean`
`--tbprofiler_opts`	Extra options in quotes for TBProfiler Type: `string`

Optional Parameters¶

These optional parameters can be useful in certain settings.

Parameter	Description
`--outdir`	Base directory to write results to Type: `string`, Default: `./`
`--run_name`	Name of the directory to hold results Type: `string`, Default: `bactopia`
`--skip_compression`	Ouput files will not be compressed Type: `boolean`
`--datasets`	The path to cache datasets to Type: `string`
`--keep_all_files`	Keeps all analysis files created Type: `boolean`

Max Job Request Parameters¶

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

Parameter	Description
`--max_retry`	Maximum times to retry a process before allowing it to fail. Type: `integer`, Default: `3`
`--max_cpus`	Maximum number of CPUs that can be requested for any single job. Type: `integer`, Default: `4`
`--max_memory`	Maximum amount of memory (in GB) that can be requested for any single job. Type: `integer`, Default: `32`
`--max_time`	Maximum amount of time (in minutes) that can be requested for any single job. Type: `integer`, Default: `120`
`--max_downloads`	Maximum number of samples to download at a time Type: `integer`, Default: `3`

Nextflow Configuration Parameters¶

Parameters to fine-tune your Nextflow setup.

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

Nextflow Profile Parameters¶