Skip to content

will-rowe/SEAR

Repository files navigation

alt tag


SEAR: Search Engine for Antimicrobial Resistance

SEAR is no longer maintained -- please now use GROOT for resistome profiling

Contents

General updates

Introduction

Versions

References

Contact


General updates

17.12.2015:   The SEAR App has been published on BaseSpace.
01.12.2015:   A Docker container image for SEAR has been created.

Introduction

The aim of this project is to provide an easy to use tool that can construct full-length, horizontally acquired Antimicrobial Resistance Genes (ARGs) from sequencing data.

SEAR has been designed with environmental metagenomics / microbiome experiments in mind, where the diversity and relative abundance of ARGs would like to be determined both quickly and easily.

SEAR outputs: ARG annotation, relative ARG abundance (%), consensus sequence and search results (from ARDB, RAC, NCBI nucleotide and protein databases).

A paper describing the design and implementation of SEAR has been published in PloS ONE.


Versions

There are several versions of SEAR available:

  1. SEAR App

  • The SEAR App is available on the BaseSpace platform (Illumina).

  • This is the recommended version to use as it is actively being developed and has the latest version of the SEAR report output.

  • Visit the SEAR App page to find out more and try the App!

  1. SEAR.docker_version

  • The Docker version of SEAR is the version behind the SEAR App. This version of SEAR runs using a 'Docker container' and will have all the required software and dependencies to run properly. An introduction to using Docker can be found here.

  • A user can use the SEAR Docker container on a local machine and run SEAR as they would a command line script.

  • Alternatively, the SEAR Docker container can be run on a server (as in the App version, which uses Amazon cloud servers).

  • The SEAR Docker container image can be pulled directly from the Docker Hub:

    docker pull wpmr/sear

  • Alternatively, the SEAR Docker container image can be built using the Dockerfile:

    docker build -t 'docker:sear' .

  1. SEAR.original_cl_version

  • The original version of SEAR is still available. This is the command line version which requires the user to set up all the required dependencies. It also requires USEARCH still, unlike the other SEAR versions that now use VSEARCH (an open source alternative to USEARCH).

  • The README.md file in SEAR.original_cl_version explains how to set up this version of SEAR.

  1. SEAR.original_web_version

  • The original of the SEAR and web interface is still available. This is an interface to run SEAR on a personal web server.

  • Uncompress the SEAR_web_version.tar.gz file and view the README.md file for instructions.

  • Screenshots are available here, here and here.


References

SEAR calls on several pieces of bioinformatic software:

Number Reference Function
1 VSEARCH used to quality check, convert and cluster reads
2 BWA-MEM used to map clustered reads to ARG reference sequences
3 SAMtools used to create ARG consensus sequences from mapped reads
4 BLAST used to compare ARG consensus sequences to online databases
5 USEARCH used in place of VSEARCH in older SEAR versions

SEAR requires a database for the initial clustering of reads. This can be a user supplied database (multifasta file) but a copy of the ARG-ANNOT database is included with SEAR and is used by default:


Contact

Please visit the SEAR forum to post a question, report a bug or start a discussion.

Alternatively, please send an email to Will Rowe at: will.rowe@liverpool.ac.uk.

About

Search Engine for Antimicrobial Resistance

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published