Skip to main content

bactopia-summary

Generate a summary table from the Bactopia results.

Usage

bactopia-summary [OPTIONS]

Required Options

OptionTypeDefaultDescription
--bactopia-path, -bSTRINGDirectory where Bactopia results are stored

Gold Cutoffs

OptionTypeDefaultDescription
--gold-coverage, -gcovINT100Minimum amount of coverage required for Gold status
--gold-quality, -gqualINT30Minimum per-read mean quality score required for Gold status
--gold-read-length, -glenINT95Minimum mean read length required for Gold status
--gold-contigs, -gcontigsINT100Maximum contig count required for Gold status

Silver Cutoffs

OptionTypeDefaultDescription
--silver-coverage, -scovINT50Minimum amount of coverage required for Silver status
--silver-quality, -squalINT20Minimum per-read mean quality score required for Silver status
--silver-read-length, -slenINT75Minimum mean read length required for Silver status
--silver-contigs, -scontigsINT200Maximum contig count required for Silver status

Fail Cutoffs

OptionTypeDefaultDescription
--min-coverage, -mincovINT20Minimum amount of coverage required to pass
--min-quality, -minqualINT12Minimum per-read mean quality score required to pass
--min-read-length, -minlenINT49Minimum mean read length required to pass
--max-contigsINT500Maximum contig count required to pass
--min-assembled-sizeINTMinimum assembled genome size
--max-assembled-sizeINTMaximum assembled genome size

Additional Options

OptionTypeDefaultDescription
--outdir, -oPATH./Directory to write output
--prefix, -pSTRINGbactopiaPrefix to use for output files
--forceBOOLfalseOverwrite existing reports
--verboseBOOLfalsePrint debug related text
--silentBOOLfalseOnly critical errors will be printed
--version, -VBOOLfalseShow the version and exit.