ariba
2.14.7
Identification de la résistance aux antimicrobiens par assemblage
Pour utiliser Ariba, veuillez consulter la page Wiki Ariba.
Veuillez noter: nous n'avons actuellement pas les ressources pour fournir un soutien à Ariba - voir la section Feedback / Issues.
Introduction
Démarrage rapide
Installation
Dépendances requises
Utilisation de PIP3
De la source
Docker
Singularité
Debian (test)
Ubuntu
Dépendances et variables d'environnement
Fichiers temporaires
Usage
Licence
Commentaires / problèmes
Citation
Ariba est un outil qui identifie les gènes de résistance aux antibiotiques en exécutant des assemblages locaux. Il peut également être utilisé pour les appels MLST.
L'entrée est un fichier FastA de séquences de référence (peut être un mélange de gènes et de séquences non codantes) et de lectures de séquençage appariées. Ariba rapporte lesquelles des séquences de référence ont été trouvées, ainsi que des informations détaillées sur la qualité des assemblages et toutes les variantes entre les lectures de séquençage et les séquences de référence.
Obtenez des données de référence, par exemple à partir de la carte. Voir GetRef pour une liste complète.
ariba getref ncbi out.ncbi
Préparer les données de référence pour Ariba:
ariba prepareref -f out.ncbi.fa -m out.ncbi.tsv out.ncbi.prepareref
Exécutez des assemblées locales et des variantes d'appel:
ariba run out.ncbi.prepareref reads1.fastq reads2.fastq out.run
Résumez les données de plusieurs analyses:
ariba summary out.summary out.run1/report1.tsv out.run2/report2.tsv out.run3/report3.tsv
Veuillez lire la page Wiki Ariba pour les instructions complètes d'utilisation.
Le tutoriel du cahier Jupyter
Si vous rencontrez un problème lors de l'installation d'Ariba, veuillez contacter votre administrateur système local. Si vous rencontrez un bug, vous pouvez le connecter ici.
Version Python3> = 3,6.0
Version Bowtie2> = 2.1.0
Version-Hit CD> = 4.6
Version Mummer> = 3,23
Ariba dépend également de plusieurs packages Python, qui sont tous disponibles via PIP. L'installation d'Ariba avec PIP3 les obtiendra automatiquement s'ils ne sont pas déjà installés:
dendropy> = 4.2.0
matplotlib> = 3.1.0
pyfastaq> = 3.12.0
pysam> = 0.9.1
pymmer> = 0,10.1
biopython
Installez Ariba à l'aide de PIP:
pip3 install ariba
Téléchargez la dernière version de ce référentiel GitHub ou le clone. Exécutez les tests:
python3 setup.py test
Remarque pour OS X: Les tests nécessitent GAWK qui devra être installé séparément, par exemple via Homebrew.
Si les tests passent tous, installez:
python3 setup.py install
Alternativement, installez-vous directement à partir de GitHub en utilisant:
pip3 install git+https://github.com/sanger-pathogens/ariba.git #--user
Ariba peut être exécuté dans un conteneur Docker. Installez d'abord Docker, puis installez la dernière version d'Ariba:
docker pull gchr.io/sanger-pathogens/ariba:latest
Toutes les images Docker sont répertoriées dans la page Packages.
Pour utiliser Ariba, utilisez une commande comme celle-ci (substituant dans vos répertoires), où vos fichiers sont supposés être stockés dans / home / ubuntu / data:
docker run --rm -it -v /home/ubuntu/data:/data sangerpathogens/ariba ariba -h
Lorsque vous appelez Ariba via Docker (comme ci-dessus), vous devrez également ajouter / data / devant tous les noms de fichiers ou de répertoires passés (par exemple / data / my_output_folder).
Ariba peut être géré dans un conteneur de singularité. Installez d'abord la singularité. Les versions incluent une image de singularité à télécharger.
Alternativement, créez votre propre image de singularité:
singularity build ariba.simg Singularity.def
Ariba est disponible dans la dernière version de Debian, et au fil du temps, filtrera progressivement Ubuntu et d'autres distributions qui utilisent Debian. Pour l'installer comme racine:
sudo apt-get install ariba
Vous pouvez utiliser apt-get (voir ci-dessus), ou pour vous assurer d'obtenir la dernière version d'Ariba, les commandes suivantes peuvent être utilisées pour installer Ariba et ses dépendances. Ceci a été testé sur une nouvelle instance d'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
Par défaut, Ariba recherchera les dépendances dans votre $PATH , en utilisant les noms dans le tableau ci-dessous. Ce comportement peut être remplacé et pointer Ariba vers un programme spécifique utilisant des variables d'environnement. La variable d'environnement est vérifiée en premier et est utilisée si elle est définie. Sinon, Ariba regarde dans votre $PATH pour le nom par défaut. Cela s'applique aux dépendances suivantes.
| Dépendance | Exécutable par défaut | Nom de la variable d'environnement |
|---|---|---|
| Bowtie2 | bowtie2 | $ARIBA_BOWTIE2 |
| CD-Hit (EST) | cd-hit-est | $ARIBA_CDHIT |
Par exemple, vous pouvez spécifier une version exacte d'un exécutable Bowtie2 que vous avez compilé et téléchargé dans votre répertoire personnel (en supposant Bash):
export ARIBA_BOWTIE2=$HOME/bowtie2-2.1.0/bowtie2
Notez qu'Ariba exécute également bowtie2-build , pour lequel il utilise l'exécutable bowtie2 avec -build annexé. Donc, dans ce cas, il essaierait d'utiliser
$HOME/bowtie2-2.1.0/bowtie2-build
Ariba peut temporairement fabriquer un grand nombre de fichiers lors de l'exécution, qui sont placés dans un répertoire temporaire réalisé par Ariba. La taille totale de ces fichiers est petite, mais il peut y en avoir beaucoup. Cela peut être un problème lors de l'exécution de grands nombres (100 ou 1000) des travaux simultanément sur le même système de fichiers. Le répertoire parent du répertoire temporaire est déterminé dans l'ordre de priorité suivant:
La valeur de l'option --tmp_dir (si cette option a été utilisée)
La variable d'environnement $ARIBA_TMPDIR (si elle est définie)
La variable d'environnement $TMPDIR (si elle est définie)
Si aucune de ce qui précède n'est trouvée, utilisez le répertoire de sortie de Run.
Chaque répertoire temporaire est unique à une série d'Ariba et est automatiquement supprimé à la fin de la course (même si Ariba a été tué par l'utilisateur ou écrasé). Par exemple,
export $ARIBA_TMPDIR=/tmp
entraînera la création d'un nouveau répertoire à l'intérieur /tmp , qui aura un nom de la forme
/tmp/ariba.tmp.abcdef
Lorsque le suffixe abcdef est une chaîne aléatoire de caractères, choisie de telle sorte que /tmp/ariba.tmp.abcdef n'existe pas déjà.
L'exception à ce qui précède est si l'option --noclean est utilisée. Cela oblige le répertoire temporaire à placer dans le répertoire de sortie et les fichiers temporaires sont conservés. Il est destiné à déboguer.
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
Veuillez lire la page Wiki Ariba pour les instructions complètes d'utilisation.
Ariba est un logiciel libre, sous licence GPLV3.
Nous n'avons actuellement pas les ressources pour fournir un soutien à Ariba. Cependant, la communauté pourrait être en mesure de vous aider si vous signalez des problèmes concernant l'utilisation du logiciel sur la page des problèmes.
Si vous utilisez ce logiciel, veuillez citer:
Ariba: Génotypage rapide de la résistance aux antimicrobiens directement à partir du séquençage Reads 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
