Skip to content
IRIDA Plugin for AMR Detection
Branch: development
Clone or download
Latest commit 16b0dd0 May 6, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
images
src/main
.gitignore
CHANGELOG.md
LICENSE
README.md
pom.xml

README.md

GitHub release Gitter

IRIDA AMR Detection Pipeline

This project contains an IRIDA plugin for a pipeline to perform AMR detection using RGI and staramr.

Installation

Installing to IRIDA

Please download the provided amr-detection-[version].jar from the releases page and copy to your /etc/irida/plugins directory. Now you may start IRIDA and you should see the pipeline appear in your list of pipelines.

Note: This plugin requires you to be running IRIDA version >= 19.01. Please see the IRIDA documentation for more details.

Installing Galaxy Dependencies

In order to use this pipeline, you will also have to install the RGI, staramr, and shovill (for assembly) Galaxy tools within your Galaxy instance. These can be found at:

Name Version Galaxy Tool
RGI 4.2.2 https://toolshed.g2.bx.psu.edu/view/card/rgi/715bc9aeef69
staramr 0.4.0 https://toolshed.g2.bx.psu.edu/view/nml/staramr/930893c83a1a
shovill 1.0.4 https://toolshed.g2.bx.psu.edu/view/iuc/shovill/865119fcb694

Tutorial

This tutorial shows how to run the AMR Detection pipeline in IRIDA.

Tutorial Data

The pipeline requires as input paired-end sequence reads in FASTQ format. We will be using Illumina MiSeq data from a sample of Campylobacter jejuni for this tutorial with run ID SRR8914694. Paired-end fastq files can be downloaded from https://www.ebi.ac.uk/ena/data/view/SRR8914694 (the FASTQ files (FTP) links). A collection of additional example data can be found in the IRIDA Sample Data package.

Adding Samples to the Cart

Once samples are created for the data and the files are uploaded, you can select the samples you wish to run and add them to the cart by clicking the Add to Cart button.

add-to-cart.png

Once you have selected your samples, you can click on the Cart button to move to selecting a pipeline.

cart-button.png

Selecting a Pipeline

Once inside the cart, you should see a card for the AMR Detection pipeline.

amr-pipeline.png

Please click the Select button to proceed with the pipeline.

Selecting Parameters

Once the pipeline is selected, the next page provides an overview of all the input files, as well as the option to modify parameters.

amr-detection-pipeline-page.png

Please make sure the Save AMR detection results to Project Line List Metadata is selected so that results get saved to the Line List. Also, please click the Customize button so that we can modify the PointFinder parameters.

modify-parameters.png

In particular, you may want to modify the Select a pointfinder organism parameter, changing the value to campylobacter. If you which to completely disable searching the PointFinder database, you can instead set Enable scanning for point mutations using the PointFinder database to false.

Once all your parameters are set, you can click the Ready to Launch? button to launch the pipeline.

launch.png

Monitoring Pipeline Status

To monitor the status of the launched pipeline, please select the Analyses > Your Analyses menu.

your-analyses.png

From here, you can monitor the status of your pipeline.

monitor-analyses.png

Analysis Results

Once the analysis pipeline is finished, you can view the analysis results in your browser or download the files to your machine.

amr-pipeline-results.png

These results show you both the staramr and RGI AMR results on the data, assembled with shovill. The staramr results show you the detected AMR genes in the Genotype column and the predicted drug resistances in the Predicted Phenotype column. The RGI results show you the predicted drug resistances in the Best_Hit_ARO column and the predicted drug resistances in the Drug Class column. For additional information, please see the detailed documentation of the respective projects.

Metadata Table

If you selected the Save AMR detection results to Project Line List Metadata option when launching the pipeline, then both the predicted AMR genes and drug resistances will be integrated into the IRIDA Line List/Metadata table as shown below.

amr-pipeline-metadata.png

Building

Installing IRIDA Libraries

To build this plugin yourself, you must first install IRIDA to your local Maven repository. Please make sure you are installing the IRIDA version defined in the irida.version.compiletime property in the pom.xml file (e.g., 19.01.3). Or, alternatively, please update the IRIDA dependency version in the pom.xml file.

To install the IRIDA libraries to a local Maven repository, please run the following from within the IRIDA project (the irida/ directory):

mvn clean install -DskipTests

Building AMR Detection Plugin

Once IRIDA is installed, you may build the pipeline plugin by running the following in this project's directory (the irida-plugin-amr-detection/ directory):

mvn clean package

This should produce a target/*.jar file, which can be copied into /etc/irida/plugins/.

Legal

Copyright 2019 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.

You can’t perform that action at this time.