ngmaster

Tags: neisseria-gonorrhoeae ng-mast typing bactopia-tool

Multi-antigen sequence typing of Neisseria gonorrhoeae.

This Bactopia Tool uses ngmaster for in silico multi-antigen sequence typing (NG-MAST) of Neisseria gonorrhoeae.

Usage

Bactopia CLI:

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

Nextflow:

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

Outputs

Expected Output Files

<BACTOPIA_DIR>
├── <SAMPLE_NAME>
│   └── tools
│       └── ngmaster-<TIMESTAMP>
│           ├── <SAMPLE_NAME>.tsv
│           └── logs
│               ├── nf.command.{begin,err,log,out,run,sh,trace}
│               └── versions.yml
└── bactopia-runs
    └── ngmaster-<TIMESTAMP>
        ├── merged-results
        │   ├── logs
        │   │   └── ngmaster-concat
        │   │       ├── nf.command.{begin,err,log,out,run,sh,trace}
        │   │       └── versions.yml
        │   └── ngmaster.tsv
        └── nf-reports
            ├── ngmaster-dag.dot
            ├── ngmaster-report.html
            └── ngmaster-timeline.html

Per-Sample Results

File	Description
*.txt	NG-MAST typing results

Merged Results

File	Description
ngmaster.tsv	Merged TSV file containing NG-MASTER 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
ngmaster-dag.dot	The Nextflow DAG visualization
ngmaster-report.html	The Nextflow Execution Report
ngmaster-timeline.html	The Nextflow Timeline Report
ngmaster-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

ngmaster Parameters

Parameter	Type	Default	Description
--ngmaster_csv	boolean	false	output comma-separated format (CSV) rather than tab-separated

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

Nextflow Profile Parameters

Parameters to fine-tune your Nextflow setup.

Parameter	Type	Default	Description
--datasets_cache	string	<HOME>/.bactopia/datasets	Directory where downloaded datasets should be stored.

Helpful Parameters

Uncommonly used parameters that might be useful.

Parameter	Type	Default	Description
--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'
--help_all	boolean		An alias for --help --show_hidden_params
--version	boolean		Display version text.

Composition

This workflow uses the following subworkflows:

• ngmaster - Perform multi-antigen sequence typing of Neisseria gonorrhoeae from genome assemblies.

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)

• ngmaster
  Kwong J, Gonçalves da Silva A, Schultz M, Seeman T ngmaster - In silico multi-antigen sequence typing for Neisseria gonorrhoeae (NG-MAST) (GitHub)

Source

View source on GitHub