Identificación de resistencia antimicrobiana por ensamblaje
Para usar ARIBA, consulte la página de Wiki de Ariba.
Tenga en cuenta: actualmente no tenemos los recursos para proporcionar soporte para ABIBA; consulte la sección Comentarios/problemas.
Introducción
Comienzo rápido
Instalación
Dependencias requeridas
Usando PIP3
De la fuente
Estibador
Singularidad
Debian (prueba)
Ubuntu
Dependencias y variables de entorno
Archivos temporales
Uso
Licencia
Comentarios/problemas
Citación
Ariba es una herramienta que identifica los genes de resistencia a los antibióticos al ejecutar ensamblajes locales. También se puede usar para la llamada MLST.
La entrada es un archivo FASTA de secuencias de referencia (puede ser una mezcla de genes y secuencias no codificantes) y lecturas de secuenciación emparejadas. ARIBA informa cuál de las secuencias de referencia se encontraron, además de información detallada sobre la calidad de los ensamblajes y cualquier variante entre las lecturas de secuenciación y las secuencias de referencia.
Obtenga datos de referencia, por ejemplo de la tarjeta. Vea GetRef para una lista completa.
ariba getref ncbi out.ncbi
Prepare datos de referencia para ABA:
ariba prepareref -f out.ncbi.fa -m out.ncbi.tsv out.ncbi.prepareref
Ejecute ensamblajes locales y variantes de llamadas:
ariba run out.ncbi.prepareref reads1.fastq reads2.fastq out.run
Resumir datos de varias ejecuciones:
ariba summary out.summary out.run1/report1.tsv out.run2/report2.tsv out.run3/report3.tsv
Lea la página de Wiki de Ariba para obtener instrucciones de uso completo.
El tutorial de Notebook Jupyter
Si se encuentra con un problema al instalar ABIBA, comuníquese con su administrador local del sistema. Si encuentra un error, puede registrarlo aquí.
Versión Python3> = 3.6.0
Versión bowtie2> = 2.1.0
Versión de hit de CD> = 4.6
Versión de Mummer> = 3.23
Ariba también depende de varios paquetes de Python, todos los cuales están disponibles a través de PIP. La instalación de ABIBA con PIP3 los obtendrá automáticamente si aún no están instalados:
dendropy> = 4.2.0
matplotlib> = 3.1.0
pyfastaq> = 3.12.0
pysam> = 0.9.1
Pymummer> = 0.10.1
biópata
Instale ARIBA usando PIP:
pip3 install ariba
Descargue el último lanzamiento de este repositorio de GitHub o clone. Ejecute las pruebas:
python3 setup.py test
Nota para OS X: las pruebas requieren GAWK que deberá instalarse por separado, por ejemplo, a través de Homebrew.
Si las pruebas se pasan, instale:
python3 setup.py install
Alternativamente, instale directamente desde GitHub usando:
pip3 install git+https://github.com/sanger-pathogens/ariba.git #--user
Ariba se puede ejecutar en un contenedor Docker. Primero instale Docker, luego instale la última versión de ABIBA:
docker pull gchr.io/sanger-pathogens/ariba:latest
Todas las imágenes de Docker se enumeran en la página de paquetes.
Para usar ARIBA, use un comando como este (sustituyendo en sus directorios), donde se supone que sus archivos se almacenan en/home/ubuntu/data:
docker run --rm -it -v /home/ubuntu/data:/data sangerpathogens/ariba ariba -h
Al llamar a ARIBA a través de Docker (como arriba), también necesitará agregar /Data / frente a todos los nombres de archivo o directorio (EG /Data /My_output_Folder).
Ariba se puede ejecutar en un contenedor de singularidad. Primera instalación de singularidad. Los lanzamientos incluyen una imagen de singularidad para descargar.
Alternativamente, construya su propia imagen de singularidad:
singularity build ariba.simg Singularity.def
Ariba está disponible en la última versión de Debian, y con el tiempo se filtrará progresivamente a Ubuntu y otras distribuciones que usan Debian. Para instalarlo como root:
sudo apt-get install ariba
Puede usar apt-get
(ver arriba), o para asegurarse de obtener la última versión de ARIBA, los siguientes comandos se pueden usar para instalar ABIBA y sus dependencias. Esto se probó en una nueva instancia de Ubuntu 16.04.
sudo apt-get update sudo apt-get install -y python3-dev python3-pip python3-tk zlib1g-dev bowtie2 mummer cd-hit export ARIBA_CDHIT=cdhit-est sudo pip3 install ariba
Por defecto, ABIBA buscará las dependencias en su $PATH
, utilizando los nombres en la tabla a continuación. Este comportamiento puede anularse y apuntar ABIBA a un programa específico utilizando variables de entorno. La variable de entorno se verifica primero y se usa si se establece. De lo contrario, ABIBA busca en su $PATH
para el nombre predeterminado. Esto se aplica a las siguientes dependencias.
Dependencia | Ejecutable predeterminado | Nombre de la variable de entorno |
---|---|---|
Bowtie2 | bowtie2 | $ARIBA_BOWTIE2 |
Hit de CD (EST) | cd-hit-est | $ARIBA_CDHIT |
Por ejemplo, puede especificar una versión exacta de un ejecutable de Bowtie2 que compiló y descargó en su directorio de inicio (suponiendo que Bash):
export ARIBA_BOWTIE2=$HOME/bowtie2-2.1.0/bowtie2
Tenga en cuenta que Aiba también ejecuta bowtie2-build
, para el cual usa el ejecutable bowtie2
con -build
Agradable. Entonces, en este caso, intentaría usar
$HOME/bowtie2-2.1.0/bowtie2-build
ABIBA puede hacer temporalmente una gran cantidad de archivos mientras se ejecutan, que se colocan en un directorio temporal realizado por ARIBA. El tamaño total de estos archivos es pequeño, pero puede haber muchos de ellos. Esto puede ser un problema cuando se ejecuta grandes números (100 o 1000) de trabajos simultáneamente en el mismo sistema de archivos. El directorio principal del directorio temporal se determina en el siguiente orden de precedencia:
El valor de la opción --tmp_dir
(si se usó esa opción)
La variable de entorno $ARIBA_TMPDIR
(si está configurada)
La variable de entorno $TMPDIR
(si está configurada)
Si no se encuentra nada de lo anterior, use el directorio de salida de la ejecución.
Cada directorio temporal es exclusivo de una ejecución de Aiba, y se elimina automáticamente al final de la ejecución (incluso si el usuario mató a Ariba o se bloqueó). Por ejemplo,
export $ARIBA_TMPDIR=/tmp
resultará en la creación de un nuevo directorio dentro /tmp
, que tendrá un nombre del formulario
/tmp/ariba.tmp.abcdef
Donde el sufijo abcdef
es una cadena aleatoria de caracteres, elegido de tal manera que /tmp/ariba.tmp.abcdef
aún no existe.
La excepción a lo anterior es si se usa la opción --noclean
. Esto obliga al directorio temporal a colocarse en el directorio de salida, y se mantienen archivos temporales. Está destinado a depurar.
usage: ariba <command> <options> optional arguments: -h, --help show this help message and exit Available commands: aln2meta Converts multi-aln fasta and SNPs to metadata expandflag Expands flag column of report file flag Translate the meaning of a flag getref Download reference data micplot Make violin/dot plots using MIC data prepareref Prepare reference data for input to "run" pubmlstget Download species from PubMLST and make db pubmlstspecies Get list of available species from PubMLST refquery Get cluster or sequence info from prepareref output run Run the local assembly pipeline summary Summarise multiple reports made by "run" test Run small built-in test dataset version Get versions and exit
Lea la página de Wiki de Ariba para obtener instrucciones de uso completo.
ARIBA es un software gratuito, con licencia bajo GPLV3.
Actualmente no tenemos los recursos para brindar apoyo a ABIBA. Sin embargo, la comunidad podría ayudarlo si informa algún problema sobre el uso del software en la página de problemas.
Si usa este software, cite:
ARIBA: Genotipado rápido de resistencia antimicrobiana directamente de la secuencia lectura Hunt M, Mather AE, Sánchez-Busó L, Page AJ, Parkhill J, Keane JA, Harris SR. Microbial Genomics 2017. DOI: 110.1099/mgen.0.000131