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

DOC: Update README #17

Merged
merged 3 commits into from
Jan 4, 2024
Merged

DOC: Update README #17

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c7206d
merge before pulling from github
VinzentRisch Jan 3, 2024
b0672ef
Merge branch 'main' into update_readme after squashmerge
VinzentRisch Jan 3, 2024
9a1845e
updated readme
VinzentRisch Jan 3, 2024
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
25 changes: 12 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,15 @@ To install _q2-amr_, follow the installation steps described below.

```shell
mamba create -yn q2-amr \
-c conda-forge -c bioconda -c qiime2 -c defaults \
-c https://packages.qiime2.org/qiime2/2023.5/tested \
--no-channel-priority \
qiime2 q2cli q2templates q2-types q2-types-genomics rgi altair
-c conda-forge -c bioconda -c qiime2 -c defaults \
-c https://packages.qiime2.org/qiime2/2023.9/shotgun/released/ \
qiime2 q2cli q2templates q2-types q2-types-genomics rgi altair

conda activate q2-amr

pip install --no-deps --force-reinstall \
git+https://github.com/misialq/rgi.git@py38-fix \
git+https://github.com/bokulich-lab/q2-amr.git
git+https://github.com/misialq/rgi.git@py38-fix \
git+https://github.com/bokulich-lab/q2-amr.git
```

Refresh cache and check that everything worked:
Expand All @@ -34,13 +33,13 @@ sequencing reads and MAGs with antimicrobial resistance genes. Currently, the [C
the implementation and usage, please refer to the [rgi](https://github.com/arpcard/rgi) documentation). Below you will
find an overview of actions available in the plugin.

| Action | Description | Underlying tool |
|----------------------------|--------------------------------------------------------------------------------------|---------------------------------------|
| fetch-card-db | Download CARD data. | [rgi](https://github.com/arpcard/rgi) |
| annotate-mags-card | Annotate MAGs with antimicrobial resistance gene information from CARD. | [rgi](https://github.com/arpcard/rgi) |
| annotate-reads-card | Annotate metagenomic reads with antimicrobial resistance gene information from CARD. | [rgi](https://github.com/arpcard/rgi) |
| heatmap | Create a heatmap from annotate-mags-card output files. | |
| visualize-annotation-stats | Plot annotate-reads-card annotation statistics. | |
| Action | Description | Underlying tool | Used function |
|----------------------------|--------------------------------------------------------------------------------------|---------------------------------------|--------------------------------------|
| fetch-card-db | Download and preprocess CARD and WildCARD data. | [rgi](https://github.com/arpcard/rgi) | card_annotation, wildcard_annotation |
| annotate-mags-card | Annotate MAGs with antimicrobial resistance gene information from CARD. | [rgi](https://github.com/arpcard/rgi) | main, load |
| annotate-reads-card | Annotate metagenomic reads with antimicrobial resistance gene information from CARD. | [rgi](https://github.com/arpcard/rgi) | bwt, load |
| heatmap | Create a heatmap from annotate-mags-card output files. | [rgi](https://github.com/arpcard/rgi) | heatmap |
| visualize-annotation-stats | Plot annotate-reads-card annotation statistics. | | |


## Dev environment
Expand Down