staramr (*AMR) scans bacterial genome contigs against the ResFinder, PointFinder, and PlasmidFinder databases (used by the ResFinder webservice and other webservices offered by the Center for Genomic Epidemiology) and compiles a summary report of detected antimicrobial resistance genes. The star|* in staramr indicates that it can handle all of the ResFinder, PointFinder, and PlasmidFinder databases.

Note: The predicted phenotypes/drug resistances are for microbiological resistance and not clinical resistance. This is provided with support from the NARMS/CIPARS Molecular Working Group and is continually being improved. A small comparison between phenotype/drug resistance predictions produced by staramr and those available from NCBI can be found in the tutorial. We welcome any feedback or suggestions.

For example:

staramr search -o out --pointfinder-organism salmonella *.fasta

out/summary.tsv:

out/detailed_summary.tsv:

out/resfinder.tsv:

out/pointfinder.tsv:

out/plasmidfinder.tsv:

out/mlst.tsv:

• Quick Usage
  • Search contigs
  • Database Info
  • Update Database
  • Restore Database
• Installation
  • Bioconda
  • PyPI/Pip
  • Latest Code
  • Dependencies
• Input
  • List of genes to exclude
  • Complex mutations
• Output
  • summary.tsv
  • detailed_summary.tsv
  • resfinder.tsv
  • pointfinder.tsv
  • plasmidfinder.tsv
  • mlst.tsv
  • settings.txt
  • hits/
• Tutorial
• Usage
  • Main Command
  • Search
  • Database Build
  • Database Update
  • Database Info
  • Database Restore Default
• Caveats
• Acknowledgements
• Citations
• Legal

To search a list of contigs (in fasta format) for AMR genes using ResFinder please run:

staramr search -o out *.fasta

Output files will be located in the directory out/.

To include acquired point-mutation resistances using PointFinder, please run:

staramr search --pointfinder-organism salmonella -o out *.fasta

Where --pointfinder-organism is the specific organism you are interested in (currently only salmonella, campylobacter, enterococcus faecalis and enterococcus faecium are supported).

To specify which PlasmidFinder database to use, please run:

staramr search --plasmidfinder-database-type enterobacteriaceae -o out *.fasta

Where --plasmidfinder-database-type is the specific database type you are interested in (currently only gram_positive, enterobacteriaceae are supported). By default, both databases are used.

To specify which MLST scheme to use, please run:

staramr search -o out --mlst-scheme senterica *.fasta

Where --mlst-scheme is the specific organism you are interested in (please visit the scheme genus map to see which are available). By default, it detects the scheme automatically.

To print information about the installed databases, please run:

staramr db info

If you wish to update to the latest ResFinder, PointFinder, and PlasmidFinder databases, you may run:

staramr db update --update-default

If you wish to switch to specific git commits of either ResFinder, PointFinder, or PlasmidFinder databases you may also pass --resfinder-commit [COMMIT], --pointfinder-commit [COMMIT], and --plasmidfinder-commit [COMMIT]. However, please note that because of compatibility issues arising from changes in the source databases, this functionality is largely unsupported and is unlikely to work for versions of the databases that StarAMR wasn't released with.

If you have updated the ResFinder/PointFinder/PlasmidFinder databases and wish to restore to the default version, you may run:

staramr db restore-default

The easiest way to install staramr is through Bioconda (we recommend using mamba as an alternative to conda).

conda install mamba # Install mamba to make it easier to install later dependencies
mamba create -c conda-forge -c bioconda -c defaults --name staramr staramr

This will install the staramr software at the most recent version within the conda environment named staramr. Bioconda will install all necessary dependencies and databases. Once this is complete you can run:

conda activate staramr # Activate conda environment
staramr --help

If, instead, you wish to install staramr to the current conda environment you can run:

mamba install -c conda-forge -c bioconda -c defaults staramr

You should now be able to run staramr --help and recieve a usage statement.

You can also install staramr from PyPI using pip:

pip install staramr

However, you will have to install the external dependencies (listed below) separately.

If you wish to make use of the latest in-development version of staramr, you may update directly from GitHub using pip:

pip install git+https://github.com/phac-nml/staramr

This will only install the Python code, you will still have to install the dependencies listed below (or run the pip command from the previously installed Bioconda environment).

Alternatively, if you wish to do development with staramr you can use a Python virtual environment (you must still install the non-Python dependencies separately).

# Clone code
git clone https://github.com/phac-nml/staramr.git
cd staramr

# Setup virtual environment
virtualenv -p /path/to/python-bin .venv
source .venv/bin/activate

# Install staramr. Use '-e' to update the install on code changes.
pip install -e .

# Now run `staramr`
staramr

Due to the way we packaged the ResFinder/PointFinder/PlasmidFinder databases, the development code will not come with a default database. You must first build the database before usage. E.g.

staramr db restore-default

• Python 3.7+
• BLAST+
• Git
• MLST 2.32.2+

By default, the ResFinder/PointFinder/PlasmidFinder genes listed in genes_to_exclude.tsv will be excluded from the final results. To pass a custom list of genes the option --exclude-genes-file can be used, where the file specified will contains a list of the sequence ids (one per line) from the ResFinder/PointFinder/PlasmidFinder databases. For example:

gene_id
gyrA_1_CP073768.1
pmrB_1_CP051284.1

Please make sure to include gene_id in the first line. The default exclusion list can also be disabled with --no-exclude-genes. Gene IDs must exactly match the FASTA record IDs provided in the source databases.

Complex mutations describe multiple point mutations that must be simultaneously present in order to confer resistance. One such example is the multiple pbp5 mutations that must be present in Enterococcus faecium in order to confer ampicillin resistance. These complex mutations may be specified by the user using a TSV-formatted file with the following format:

Where positions is all the point mutations to group into the complex mutation (optional and mandatory), mandatory is all the point mutations that must be present for the complex mutation to be reported (mandatory is a subset of positions), and phenotype is the phenotype that is conferred when this set of mutations is present. To see a specific example of this, please look at the default complex_mutations.tsv file included with StarAMR. The mutation will be reported in the pointfinder.tsv file similar to as follows:

The complex mutation TSV file may be specifed on the command line when running Pointfinder:

staramr search --pointfinder-organism enterococcus_faecium -o out pbp5.fa --complex-mutations-file complex_mutations.tsv

There are 8 different output files produced by staramr:

1. summary.tsv: A summary of all detected AMR genes/mutations/plasmids/sequence type in each genome, one genome per line. A series of descriptive statistics is also provided for each genome as well as feedback for whether or not the genome passes several quality metrics and if not, feedback on why the genome fails.
2. detailed_summary.tsv: A detailed summary of all detected AMR genes/mutations/plasmids/sequence type in each genome, one gene per line.
3. resfinder.tsv: A tabular file of each AMR gene and additional BLAST information from the ResFinder database, one gene per line.
4. pointfinder.tsv: A tabular file of each AMR point mutation and additional BLAST information from the PointFinder database, one gene per line.
5. plasmidfinder.tsv: A tabular file of each AMR plasmid type and additional BLAST information from the PlasmidFinder database, one plasmid type per line.
6. mlst.tsv: A tabular file of each multi-locus sequence type (MLST) and it's corresponding locus/alleles, one genome per line.
7. settings.txt: The command-line, database versions, and other settings used to run staramr.
8. results.xlsx: An Excel spreadsheet containing the previous 6 files as separate worksheets.

In addition, the directory hits/ stores fasta files of the specific blast hits.

The summary.tsv output file generated by staramr contains the following columns:

• Isolate ID: The id of the isolate/genome file(s) passed to staramr.
• Quality Module: The isolate/genome file(s) pass/fail result(s) for the quality metrics
• Genotype: The AMR genotype of the isolate.
• Predicted Phenotype: The predicted AMR phenotype (drug resistances) for the isolate.
• CGE Predicted Phenotype: The CGE-predicted AMR phenotype (drug resistances) for the isolate.
• Plasmid: Plasmid types that were found for the isolate.
• Scheme: The MLST scheme used
• Sequence Type: The sequence type that's assigned when combining all allele types
• Genome Length: The isolate/genome file(s) genome length(s)
• N50 value: The isolate/genome file(s) N50 value(s)
• Number of Contigs Greater Than Or Equal To 300 bp: The number of contigs greater or equal to 300 base pair in the isolate/genome file(s)
• Quality Module Feedback: The isolate/genome file(s) detailed feedback for the quality metrics

The detailed_summary.tsv output file generated by staramr contains the following columns:

• Isolate ID: The id of the isolate/genome file(s) passed to staramr.
• Data: The particular gene detected from ResFinder, PlasmidFinder, PointFinder, or the sequence type.
• Data Type: The type of gene (Resistance or Plasmid), or MLST.
• Predicted Phenotype: The predicted AMR phenotype (drug resistances) found in ResFinder/PointFinder. Plasmids will be left blank by default.
• CGE Predicted Phenotype: The CGE-predicted AMR phenotype (drug resistances) found in ResFinder/PointFinder. Plasmids will be left blank by default.
• %Identity: The % identity of the top BLAST HSP to the gene.
• %Overlap: THe % overlap of the top BLAST HSP to the gene (calculated as hsp length/total length * 100).
• HSP Length/Total Length The top BLAST HSP length over the gene total length (nucleotides).
• Contig: The contig id containing this gene.
• Start: The start of the gene (will be greater than End if on minus strand).
• End: The end of the gene.
• Accession: The accession of the gene from either ResFinder or PlasmidFinder database.

The resfinder.tsv output file generated by staramr contains the following columns:

• Isolate ID: The id of the isolate/genome file(s) passed to staramr.
• Gene: The particular AMR gene detected.
• Predicted Phenotype: The predicted AMR phenotype (drug resistances) for this gene.
• CGE Predicted Phenotype: The CGE-predicted AMR phenotype (drug resistances) for this gene.
• %Identity: The % identity of the top BLAST HSP to the AMR gene.
• %Overlap: THe % overlap of the top BLAST HSP to the AMR gene (calculated as hsp length/total length * 100).
• HSP Length/Total Length The top BLAST HSP length over the AMR gene total length (nucleotides).
• Contig: The contig id containing this AMR gene.
• Start: The start of the AMR gene (will be greater than End if on minus strand).
• End: The end of the AMR gene.
• Accession: The accession of the AMR gene in the ResFinder database.
• Sequence: The AMR Gene sequence
• CGE Notes: Any CGE notes associated with the prediction.

The pointfinder.tsv output file generated by staramr contains the following columns:

• Isolate ID: The id of the isolate/genome file(s) passed to staramr.
• Gene: The particular AMR gene detected, with the point mutation within.
• Predicted Phenotype: The predicted AMR phenotype (drug resistances) for this gene.
• CGE Predicted Phenotype: The CGE-predicted AMR phenotype (drug resistances) for this gene.
• Type: The type of this mutation from PointFinder (either codon or nucleotide).
• Position: The position of the mutation. For codon type, the position is the codon number in the gene, for nucleotide type it is the nucleotide number.
• Mutation: The particular mutation. For codon type lists the codon mutation, for nucleotide type lists the single nucleotide mutation.
• %Identity: The % identity of the top BLAST HSP to the AMR gene.
• %Overlap: The % overlap of the top BLAST HSP to the AMR gene (calculated as hsp length/total length * 100).
• HSP Length/Total Length The top BLAST HSP length over the AMR gene total length (nucleotides).
• Contig: The contig id containing this AMR gene.
• Start: The start of the AMR gene (will be greater than End if on minus strand).
• End: The end of the AMR gene.
• Pointfinder Position: The Pointfinder-adjusted position, which may be off by one from the sequence position in the case of some indels.
• CGE Notes: Any CGE notes associated with the prediction.
• CGE Required Mutation: Any additional mutations that CGE predicts are required to confer the CGE predicted phenotype.
• CGE Mechanism: The CGE-reported mechanism.
• CGE PMID: The PMID ID associated with the CGE prediction.

The plasmidfinder.tsv output file generated by staramr contains the following columns:

• Isolate ID: The id of the isolate/genome file(s) passed to staramr.
• Plasmid: The particular plasmid type detected.
• %Identity: The % identity of the top BLAST HSP to the plasmid type.
• %Overlap: The % overlap of the top BLAST HSP to the plasmid type (calculated as hsp length/total length * 100).
• HSP Length/Total Length The top BLAST HSP length over the plasmid type total length (nucleotides).
• Contig: The contig id containing this plasmid type.
• Start: The start of the plasmid type (will be greater than End if on minus strand).
• End: The end of the plasmid type.
• Accession: The accession of the plasmid type in the PlasmidFinder database.

The mlst.tsv output file generated by staramr contains the following columns:

• Isolate ID: The id of the isolate/genome file(s) passed to staramr.
• Scheme: The scheme that MLST has identified.
• Sequence Type: The sequence type that's assigned when combining all allele types
• Locus #: A particular locus in the specified MLST scheme.

The settings.txt file contains the particular settings used to run staramr.

• command_line: The command line used to run staramr.
• version: The version of staramr.
• start_time,end_time,total_minutes: The start, end, and duration for running staramr.
• resfinder_db_dir, pointfinder_db_dir, plasmidfinder_db_dir : The directory containing the ResFinder, PointFinder, and PlasmidFinder databases.
• resfinder_db_url, pointfinder_db_url, plasmidfinder_db_url: The URL to the git repository for the ResFinder, PointFinder, and PlasmidFinder databases.
• resfinder_db_commit, pointfinder_db_commit, plasmidfinder_db_commit: The git commit ids for the ResFinder, PointFinder, and PlasmidFinder databases.
• resfinder_db_date, pointfinder_db_date, plasmidfinder_db_date: The date of the git commits of the ResFinder, PointFinder, and PlasmidFinder databases.
• mlst_version: The version of MLST.
• pointfinder_gene_drug_version, resfinder_gene_drug_version: A version identifier for the gene/drug mapping table used by staramr.

command_line                  = staramr search -o out staramr/tests/integration/data/16S-rc_gyrA-rc_beta-lactam.fsa
version                       = 0.11.1
start_time                    = 2026-02-26 14:09:48
end_time                      = 2026-02-26 14:09:49
total_minutes                 = 0.01
resfinder_db_dir              = staramr/databases/data/dist/resfinder
resfinder_db_url              = https://bitbucket.org/genomicepidemiology/resfinder_db.git
resfinder_db_commit           = 65c9ba3b680d13fe5eb13ec78bf1a4160ef4c6d7
resfinder_db_date             = Sun, 04 May 2025 18:02
pointfinder_db_dir            = staramr/databases/data/dist/pointfinder
pointfinder_db_url            = https://bitbucket.org/genomicepidemiology/pointfinder_db.git
pointfinder_db_commit         = 694919f59a38980204009e7ade76bf319cb7df0b
pointfinder_db_date           = Thu, 08 Aug 2024 11:57
pointfinder_organisms_all     = campylobacter, enterococcus_faecalis, enterococcus_faecium, escherichia_coli, helicobacter_pylori, klebsiella, mycobacterium_tuberculosis, neisseria_gonorrhoeae, plasmodium_falciparum, salmonella, staphylococcus_aureus
pointfinder_organisms_valid   = campylobacter, enterococcus_faecalis, enterococcus_faecium, escherichia_coli, helicobacter_pylori, salmonella
plasmidfinder_db_dir          = staramr/databases/data/dist/plasmidfinder
plasmidfinder_db_url          = https://bitbucket.org/genomicepidemiology/plasmidfinder_db.git
plasmidfinder_db_commit       = 49c24c1c9401fa175fbcfdbd4b37227a160baca4
plasmidfinder_db_date         = Wed, 10 Sep 2025 18:56
mlst_version                  = 2.32.2
pointfinder_organism          = None
pointfinder_gene_drug_version = 070623
resfinder_gene_drug_version   = 072423

The hits/ directory contains the BLAST HSP nucleotides for the entries listed in the resfinder.tsv and pointfinder.tsv files. There are up to two files per input genome, one for ResFinder and one for PointFinder.

For example, with an input genome named SRR1952908.fasta there would be two files hits/resfinder_SRR1952908.fasta and hits/pointfinder_SRR1952908.fasta. These files contain mostly the same information as in the resfinder.tsv, pointfinder.tsv, and plasmidfinder.tsv files. Additional information is the database_gene_start and database_gene_end listing the start/end of the BLAST HSP on the AMR resistance gene from the ResFinder/PointFinder/PlasmidFinder databases.

>aadA1_3_JQ414041 isolate: SRR1952908, contig: contig00030, contig_start: 5355, contig_end: 4564, database_gene_start: 1, database_gene_end: 792, hsp/length: 792/792, pid: 100.00%, plength: 100.00%
ATGAGGGAAGCGGTGATCGCCGAAGTATCGACTCAACTATCAGAGGTAGTTGGCGTCATC
GAGCGCCATCTCGAACCGACGTTGCTGGCCGTACATTTGTACGGCTCCGCAGTGGATGGC
...

A tutorial guiding you though the usage of staramr, interpreting the results, and comparing with antimicrobial resistances available on NCBI can be found at staramr tutorial.

Main staramr command. Can be used to set global options (primarily --verbose).

usage: staramr [-h] [--verbose] [-V] {search,db} ...

Do AMR detection for genes and point mutations

positional arguments:
  {search,db}    Subcommand for AMR detection.
    search       Search for AMR genes
    db           Download ResFinder/PointFinder/PlasmidFinder databases

options:
  -h, --help     show this help message and exit
  --verbose      Turn on verbose logging [False].
  -V, --version  show program's version number and exit

Searches input FASTA files for AMR genes.

usage: staramr search [-h] [--pointfinder-organism POINTFINDER_ORGANISM] [--plasmidfinder-database-type PLASMIDFINDER_DATABASE_TYPE] [-d DATABASE]
                      [-n NPROCS] [--ignore-invalid-files] [--mlst-scheme MLST_SCHEME] [--genome-size-lower-bound GENOME_SIZE_LOWER_BOUND]
                      [--genome-size-upper-bound GENOME_SIZE_UPPER_BOUND] [--minimum-N50-value MINIMUM_N50_VALUE]
                      [--minimum-contig-length MINIMUM_CONTIG_LENGTH] [--unacceptable-number-contigs UNACCEPTABLE_NUM_CONTIGS]
                      [--pid-threshold PID_THRESHOLD] [--percent-length-overlap-resfinder PLENGTH_THRESHOLD_RESFINDER]
                      [--percent-length-overlap-pointfinder PLENGTH_THRESHOLD_POINTFINDER]
                      [--percent-length-overlap-plasmidfinder PLENGTH_THRESHOLD_PLASMIDFINDER] [--no-exclude-genes]
                      [--exclude-genes-file EXCLUDE_GENES_FILE] [--exclude-negatives] [--exclude-resistance-phenotypes] [--report-all-blast]
                      [--complex-mutations-file COMPLEX_MUTATIONS_FILE] [-o OUTPUT_DIR] [--output-summary OUTPUT_SUMMARY]
                      [--output-detailed-summary OUTPUT_DETAILED_SUMMARY] [--output-resfinder OUTPUT_RESFINDER]
                      [--output-pointfinder OUTPUT_POINTFINDER] [--output-plasmidfinder OUTPUT_PLASMIDFINDER] [--output-settings OUTPUT_SETTINGS]
                      [--output-excel OUTPUT_EXCEL] [--output-hits-dir HITS_OUTPUT_DIR] [--output-mlst OUTPUT_MLST]
                      files [files ...]

positional arguments:
  files

options:
  -h, --help            show this help message and exit
  --pointfinder-organism POINTFINDER_ORGANISM
                        The organism to use for pointfinder. Validated: {'enterococcus_faecium', 'helicobacter_pylori', 'campylobacter', 'escherichia_coli', 'enterococcus_faecalis', 'salmonella'}. All: {'mycobacterium_tuberculosis', 'klebsiella', 'staphylococcus_aureus', 'plasmodium_falciparum', 'enterococcus_faecium', 'helicobacter_pylori', 'campylobacter', 'escherichia_coli', 'neisseria_gonorrhoeae', 'enterococcus_faecalis', 'salmonella'}. Defaults to disabling search for point mutations. [None].
  --plasmidfinder-database-type PLASMIDFINDER_DATABASE_TYPE
                        The database type to use for plasmidfinder {gram_positive, enterobacteriales}. Defaults to using all available database types to search for plasmids. [None].
  -d DATABASE, --database DATABASE
                        The directory containing the resfinder/pointfinder/plasmidfinder databases [staramr/staramr/databases/data].
  -n NPROCS, --nprocs NPROCS
                        The number of processing cores to use [24].
  --ignore-invalid-files
                        Skips over invalid input files
  --mlst-scheme MLST_SCHEME
                        Specify scheme name, visit https://github.com/tseemann/mlst/tree/master/db/pubmlst for supported scheme genera available. [None] 
  --genome-size-lower-bound GENOME_SIZE_LOWER_BOUND
                        The lower bound for our genome size for the quality metrics. Defaults to 4 Mbp. [4000000].
  --genome-size-upper-bound GENOME_SIZE_UPPER_BOUND
                        The upper bound for our genome size for the quality metrics. Defaults to 6 Mbp. [6000000].
  --minimum-N50-value MINIMUM_N50_VALUE
                        The minimum N50 value for the quality metrics. Defaults to 10000. [10000].
  --minimum-contig-length MINIMUM_CONTIG_LENGTH
                        The minimum contig length for the quality metrics. Defaults to 300 bp. [300].
  --unacceptable-number-contigs UNACCEPTABLE_NUM_CONTIGS
                        The minimum, unacceptable number of contigs which are equal to or above the minimum contig length for our quality metrics. Defaults to 1000. [1000].

BLAST Thresholds:
  --pid-threshold PID_THRESHOLD
                        The percent identity threshold [98.0].
  --percent-length-overlap-resfinder PLENGTH_THRESHOLD_RESFINDER
                        The percent length overlap for resfinder results [60.0].
  --percent-length-overlap-pointfinder PLENGTH_THRESHOLD_POINTFINDER
                        The percent length overlap for pointfinder results [95.0].
  --percent-length-overlap-plasmidfinder PLENGTH_THRESHOLD_PLASMIDFINDER
                        The percent length overlap for resfinder results [60.0].

Reporting options:
  --no-exclude-genes    Disable the default exclusion of some genes from ResFinder/PointFinder/PlasmidFinder [False].
  --exclude-genes-file EXCLUDE_GENES_FILE
                        A list of ResFinder/PointFinder/PlasmidFinder gene names to exclude from results [staramr/databases/exclude/data/genes_to_exclude.tsv].
  --exclude-negatives   Exclude negative results (those susceptible to antimicrobials) [False].
  --exclude-resistance-phenotypes
                        Exclude predicted antimicrobial resistances [False].
  --report-all-blast    Report all blast hits (vs. only top blast hits) [False].
  --complex-mutations-file COMPLEX_MUTATIONS_FILE
                        A list of multiple PointFinder point mutations that together confer a single phenotype [staramr/databases/resistance/pointfinder/complex/data/complex_mutations.tsv].

Output:
  Use either --output-dir or specify individual output files

  -o OUTPUT_DIR, --output-dir OUTPUT_DIR
                        The output directory for results [None].
  --output-summary OUTPUT_SUMMARY
                        The name of the output file containing the summary results. Not be be used with '--output-dir'. [None]
  --output-detailed-summary OUTPUT_DETAILED_SUMMARY
                        The name of the output file containing the detailed summary results. Not be be used with '--output-dir'. [None]
  --output-resfinder OUTPUT_RESFINDER
                        The name of the output file containing the resfinder results. Not be be used with '--output-dir'. [None]
  --output-pointfinder OUTPUT_POINTFINDER
                        The name of the output file containing the pointfinder results. Not be be used with '--output-dir'. [None]
  --output-plasmidfinder OUTPUT_PLASMIDFINDER
                        The name of the output file containing the plasmidfinder results. Not be be used with '--output-dir'. [None]
  --output-settings OUTPUT_SETTINGS
                        The name of the output file containing the settings. Not be be used with '--output-dir'. [None]
  --output-excel OUTPUT_EXCEL
                        The name of the output file containing the excel results. Not be be used with '--output-dir'. [None]
  --output-hits-dir HITS_OUTPUT_DIR
                        The name of the directory to contain the BLAST hit files. Not be be used with '--output-dir'. [None]
  --output-mlst OUTPUT_MLST
                        The name of the output file containing the mlst results. Not be be used with '--output-dir'. [None]

Example:
        staramr search -o out *.fasta
                Searches the files *.fasta for AMR genes using only the ResFinder database, storing results in the out/ directory.

        staramr search --pointfinder-organism salmonella --output-excel results.xlsx *.fasta
                Searches *.fasta for AMR genes using ResFinder and PointFinder database with the passed organism, storing results in results.xlsx.

Downloads and builds the ResFinder, PointFinder, and PlasmidFinder databases.

usage: staramr db build [-h] [--dir DESTINATION] [--resfinder-commit RESFINDER_COMMIT] [--pointfinder-commit POINTFINDER_COMMIT]
                        [--plasmidfinder-commit PLASMIDFINDER_COMMIT]

options:
  -h, --help            show this help message and exit
  --dir DESTINATION     The directory to download the databases into [staramr/staramr/databases/data].
  --resfinder-commit RESFINDER_COMMIT
                        The specific git commit for the resfinder database [latest].
  --pointfinder-commit POINTFINDER_COMMIT
                        The specific git commit for the pointfinder database [latest].
  --plasmidfinder-commit PLASMIDFINDER_COMMIT
                        The specific git commit for the plasmidfinder database [latest].

Example:
        staramr db build
                Builds a new ResFinder/PointFinder/PlasmidFinder database under staramr/databases/data if it does not exist

        staramr db build --dir databases
                Builds a new ResFinder/PointFinder/PlasmidFinder database under databases/

Updates an existing download of the ResFinder, PointFinder, and PlasmidFinder databases.

usage: staramr db update [-h] [-d] [--resfinder-commit RESFINDER_COMMIT] [--pointfinder-commit POINTFINDER_COMMIT]
                         [--plasmidfinder-commit PLASMIDFINDER_COMMIT]
                         [directories ...]

positional arguments:
  directories

options:
  -h, --help            show this help message and exit
  -d, --update-default  Updates default database directory (staramr/databases/data).
  --resfinder-commit RESFINDER_COMMIT
                        The specific git commit for the resfinder database [latest].
  --pointfinder-commit POINTFINDER_COMMIT
                        The specific git commit for the pointfinder database [latest].
  --plasmidfinder-commit PLASMIDFINDER_COMMIT
                        The specific git commit for the plasmidfinder database [latest].

Example:
        staramr db update databases/
                Updates the ResFinder/PointFinder/PlasmidFinder database under databases/

        staramr db update -d
                Updates the default ResFinder/PointFinder/PlasmidFinder database under staramr/databases/data

Prints information about an existing build of the ResFinder/PointFinder/PlasmidFinder databases.

usage: staramr db info [-h] [directories ...]

positional arguments:
  directories

options:
  -h, --help   show this help message and exit

Example:
        staramr db info
                Prints information about the default database in staramr/databases/data

        staramr db info databases
                Prints information on the database stored in databases/

Restores the default database for staramr.

usage: staramr db restore-default [-h] [-f]

options:
  -h, --help   show this help message and exit
  -f, --force  Force restore without asking for confirmation.

Example:
        staramr db restore-default
                Restores the default ResFinder/PointFinder/PlasmidFinder database

This software is still a work-in-progress. In particular, not all organisms stored in the PointFinder database are supported (only enterococcus_faecalis, helicobacter_pylori, enterococcus_faecium, campylobacter, escherichia_coli, salmonella are currently supported). Additionally, the predicted phenotypes are for microbiological resistance and not clinical resistance. Phenotype/drug resistance predictions are an experimental feature which is continually being improved.

staramr only works on assembled genomes and not directly on reads. A quick genome assembler you could use is Shovill. Or, you may also wish to try out the ResFinder webservice, or the command-line tools rgi or ariba which will work on sequence reads as well as genome assemblies. You may also wish to check out the CARD webservice.

Some ideas for the software were derived from the ResFinder, PointFinder, and PlasmidFinder command-line software, as well as from ABRicate and from SISTR (Salmonella In Silico Typing Resource) command-line tool .

Phenotype/drug resistance predictions are provided with support from the NARMS/CIPARS Molecular Working Group.

The Multi-locus sequence typing program is from the MLST Github.

If you find staramr useful, please cite the following paper:

Bharat A, Petkau A, Avery BP, Chen JC, Folster JP, Carson CA, Kearney A, Nadon C, Mabon P, Thiessen J, Alexander DC, Allen V, El Bailey S, Bekal S, German GJ, Haldane D, Hoang L, Chui L, Minion J, Zahariadis G, Domselaar GV, Reid-Smith RJ, Mulvey MR. Correlation between Phenotypic and In Silico Detection of Antimicrobial Resistance in Salmonella enterica in Canada Using Staramr. Microorganisms. 2022; 10(2):292. https://doi.org/10.3390/microorganisms10020292

You may also consider citing the following (databases or other resources used by staramr):

Zankari E, Hasman H, Cosentino S, Vestergaard M, Rasmussen S, Lund O, Aarestrup FM, Larsen MV. 2012. Identification of acquired antimicrobial resistance genes. J. Antimicrob. Chemother. 67:2640–2644. doi: 10.1093/jac/dks261

Zankari E, Allesøe R, Joensen KG, Cavaco LM, Lund O, Aarestrup F. PointFinder: a novel web tool for WGS-based detection of antimicrobial resistance associated with chromosomal point mutations in bacterial pathogens. J Antimicrob Chemother. 2017; 72(10): 2764–8. doi: 10.1093/jac/dkx217

Carattoli A, Zankari E, Garcia-Fernandez A, Voldby Larsen M, Lund O, Villa L, Aarestrup FM, Hasman H. PlasmidFinder and pMLST: in silico detection and typing of plasmids. Antimicrob. Agents Chemother. 2014. April 28th. doi: 10.1128/AAC.02412-14

Seemann T, MLST Github https://github.com/tseemann/mlst

Jolley KA, Bray JE and Maiden MCJ. Open-access bacterial population genomics: BIGSdb software, the PubMLST.org website and their applications [version 1; peer review: 2 approved]. Wellcome Open Res 2018, 3:124. doi: 10.12688/wellcomeopenres.14826.1

Copyright 2018 Government of Canada

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.