Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Citation and README updates #160

Merged
merged 4 commits into from
Jan 15, 2025
Merged

Citation and README updates #160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f5127bb
Update README.md to remove warnings
evolarjun Dec 22, 2024
7ea49f3
Updated and fixed citation file
evolarjun Jan 15, 2025
6be1e44
typo in citation file
evolarjun Jan 15, 2025
76541af
Move to markdown file for citation information
evolarjun Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 0 additions & 39 deletions CITATION.cff
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions CITATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Please see our [wiki instructions on citing AMRFinderPlus](https://github.com/ncbi/amr/wiki#citation) for more information on how to cite AMRFinderPlus. Importantly we ask that you include both the software version and database version in your methods so people can reproduce your results.
14 changes: 0 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,3 @@
# WARNING: This is an experimental version that includes StxTyper

Currently it will need to be compiled from source to install.

### Downloading and compiling AMRFinderPlus with StxTyper

git clone https://github.com/ncbi/amr.git
cd amr
git checkout stxtype
git submodule update --init
make
./amrfinder -u
make test

# NCBI Antimicrobial Resistance Gene Finder (AMRFinderPlus)

This software and the accompanying database are designed to find acquired antimicrobial resistance genes and point mutations in protein and/or assembled nucleotide sequences. We have also added "plus" stress, heat, and biocide resistance and virulence factors for [some organisms](https://github.com/evolarjun/amr/wiki/Curated-organisms).
Expand Down
Loading