Skip to main content

staphscan

Tags: staphylococcus-aureus surveillance mlst spa-typing sccmec amr virulence sample-scope

Genome-based surveillance analysis of Staphylococcus aureus.

Uses StaphSCAN to perform genome-based surveillance of Staphylococcus aureus, integrating species identification, MLST, spa typing, SCCmec typing, capsular typing, and detection of virulence, biofilm, and antimicrobial resistance genes.

Inputs

record (
meta: Record,
fna: Path
)
FieldTypeDescription
metaRecordGroovy Record containing sample information
fnaPathAssembled contigs in FASTA format
db: Path?
NameTypeDescription
dbPath?Custom MLST database directory

Outputs

record (
meta: Record,
tsv: Path,
results: Set<Path>,
logs: Set<Path?>,
nf_logs: Set<Path>,
versions: Set<Path>
)
FieldTypeDescription
metaRecordSample information record
tsvPathPer-sample surveillance summary with MLST, spa type, SCCmec, capsule, AGR, resistance, biofilm, and virulence results
resultsSet<Path>All output files to be published
logsSet<Path?>Optional program specific log files
nf_logsSet<Path>Nextflow-specific log files (e.g. .command.{begin
versionsSet<Path>A YAML formatted file with program versions

Parameters

StaphSCAN Parameters

ParameterTypeDefaultDescription
--staphscan_modulesstringComma-separated list of modules to run
--staphscan_db_mlststring-Path or tarball to custom MLST database

Used By

Subworkflows

  • staphscan - Genome-based surveillance analysis of Staphylococcus aureus.

Workflows

  • staphscan - Genome-based surveillance analysis of Staphylococcus aureus.

Citations

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

Source

View source on GitHub

Version

STAPHSCAN:
- staphscan: 0.4.1