Skip to content

Commit

Permalink
MAINT: Remove all functionality for AMRFinderPlus (#106)
Browse files Browse the repository at this point in the history
  • Loading branch information
VinzentRisch authored Oct 4, 2024
1 parent 7f5f964 commit 6d140d9
Show file tree
Hide file tree
Showing 219 changed files with 60 additions and 1,202 deletions.
27 changes: 13 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To install _q2-amr_, follow the steps described below.
mamba create -yn q2-amr \
-c https://packages.qiime2.org/qiime2/2024.2/shotgun/released/ \
-c qiime2 -c conda-forge -c bioconda -c defaults \
qiime2 q2cli q2templates q2-types q2-feature-table q2-demux rgi tqdm ncbi-amrfinderplus
qiime2 q2cli q2templates q2-types q2-feature-table q2-demux rgi tqdm

conda activate q2-amr

Expand All @@ -38,7 +38,7 @@ qiime info
CONDA_SUBDIR=osx-64 mamba create -yn q2-amr \
-c https://packages.qiime2.org/qiime2/2024.2/shotgun/released/ \
-c qiime2 -c conda-forge -c bioconda -c defaults \
qiime2 q2cli q2templates q2-types q2-feature-table q2-demux rgi tqdm ncbi-amrfinderplus
qiime2 q2cli q2templates q2-types q2-feature-table q2-demux rgi tqdm

conda activate q2-amr
conda config --env --set subdir osx-64
Expand All @@ -57,20 +57,19 @@ qiime info

## Functionality
This QIIME 2 plugin contains actions used to annotate short single/paired-end
sequencing reads and MAGs with antimicrobial resistance genes. Currently, the tools [RGI](https://github.com/arpcard/rgi) and [AMRFinderPlus](https://github.com/ncbi/amr) are supported (for details on
the implementation and usage, please refer to the documentation of the tools). Below you will
sequencing reads and MAGs with antimicrobial resistance genes. Currently, the [CARD](https://card.mcmaster.ca) database is supported (for details on
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 | 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 |
| kmer-query-mags-card | Pathogen-of-origin prediction for ARGs in MAGs. | [rgi](https://github.com/arpcard/rgi) | kmer-query, load |
| kmer-query-reads-card | Pathogen-of-origin prediction for ARGs in reads. | [rgi](https://github.com/arpcard/rgi) | kmer-query, load |
| kmer-build-card | Build a kmer database with a custom kmer length. | [rgi](https://github.com/arpcard/rgi) | kmer-build |
| fetch-amrfinderplus-db | Download AMRFinderPlus database. | [AMRFinderPlus](https://github.com/ncbi/amr) | -u |
| 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 |
| kmer-query-mags-card | Pathogen-of-origin prediction for ARGs in MAGs. | [RGI](https://github.com/arpcard/rgi) | kmer-query, load |
| kmer-query-reads-card | Pathogen-of-origin prediction for ARGs in reads. | [RGI](https://github.com/arpcard/rgi) | kmer-query, load |
| kmer-build-card | Build a kmer database with a custom kmer length. | [RGI](https://github.com/arpcard/rgi) | kmer-build |

## Dev environment
This repository follows the _black_ code style. To make the development slightly easier
Expand Down
1 change: 0 additions & 1 deletion ci/recipe/meta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ requirements:
- setuptools

run:
- ncbi-amrfinderplus
- python=3.8.*
- qiime2 {{ qiime2_epoch }}.*
- q2-demux {{ qiime2_epoch }}.*
Expand Down
50 changes: 0 additions & 50 deletions q2_amr/amrfinderplus/database.py

This file was deleted.

130 changes: 0 additions & 130 deletions q2_amr/amrfinderplus/sample_data.py

This file was deleted.

7 changes: 0 additions & 7 deletions q2_amr/amrfinderplus/tests/__init__.py

This file was deleted.

52 changes: 0 additions & 52 deletions q2_amr/amrfinderplus/tests/test_database.py

This file was deleted.

Loading

0 comments on commit 6d140d9

Please sign in to comment.