Bactopia Tool - `rgi`¶

The rgi module uses Resistance Gene Identifier (RGI) to identify antibiotic resistance genes in assemblies.

Example Usage¶

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

Output Overview¶

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

<BACTOPIA_DIR>
├── <SAMPLE_NAME>
│   └── tools
│       └── rgi
│           ├── <SAMPLE_NAME>.json
│           ├── <SAMPLE_NAME>.txt
│           └── logs
│               ├── nf-rgi.{begin,err,log,out,run,sh,trace}
│               └── versions.yml
└── bactopia-runs
    └── rgi-<TIMESTAMP>
        ├── merged-results
        │   ├── logs
        │   │   ├── rgi-concat
        │   │   │   ├── nf-merged-results.{begin,err,log,out,run,sh,trace}
        │   │   │   └── versions.yml
        │   │   └── rgi-heatmap
        │   │       ├── nf-merged-results.{begin,err,log,out,run,sh,trace}
        │   │       └── versions.yml
        │   ├── rgi-2.{csv,eps,png}
        │   └── rgi.tsv
        └── nf-reports
            ├── rgi-dag.dot
            ├── rgi-report.html
            ├── rgi-timeline.html
            └── rgi-trace.txt

Results¶

Merged Results¶

Below are results that are concatenated into a single file.

Filename	Description
rgi.tsv	A merged TSV file with `rgi` results from all samples
rgi-2.{csv,eps,png}	Heatmap representations as text and images, see RGI - Heatmap for more details

rgi¶

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

Filename	Description
<SAMPLE_NAME>.json	A JSON file with `rgi` results
<SAMPLE_NAME>.txt	A tab-delimited file with `egi` results, see RGI - Output Details for more details

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
rgi-dag.dot	The Nextflow DAG visualisation
rgi-report.html	The Nextflow Execution Report
rgi-timeline.html	The Nextflow Timeline Report
rgi-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`

RGI Parameters¶

Parameter	Description
`--use_diamond`	Use DIAMOND for alignments instead of BLAST Type: `boolean`
`--include_loose`	Include loose hits in addition to strict and perfect hits Type: `boolean`
`--exclude_nudge`	Exclude hits nudged from loose to strict hits Type: `boolean`
`--rgi_frequency`	Represent samples based on resistance profile Type: `boolean`
`--rgi_category`	Organize resistance genes based on a category Type: `string`
`--rgi_cluster`	Use SciPy's hiearchical clustering algorithm to cluster rows (AMR genes) or columns (samples) Type: `string`
`--rgi_display`	Specify display options for categories Type: `string`, Default: `plain`

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¶