ariba
2.14.7
Identifizierung antimikrobieller Resistenz durch Zusammenbau
Um Ariba zu verwenden, finden Sie auf der Ariba Wiki -Seite.
Bitte beachten Sie: Wir verfügen derzeit nicht über die Ressourcen, um Ariba zu unterstützen - siehe Abschnitt Feedback/Ausgaben.
Einführung
Schneller Start
Installation
Erforderliche Abhängigkeiten
Mit PIP3
Von Quelle
Docker
Singularität
Debian (Test)
Ubuntu
Abhängigkeiten und Umgebungsvariablen
Temporäre Dateien
Verwendung
Lizenz
Feedback/Probleme
Zitat
Ariba ist ein Werkzeug, das Antibiotika -Resistenzgene identifiziert, indem lokale Assemblys ausgeführt werden. Es kann auch für MLST -Anrufe verwendet werden.
Die Eingabe ist eine Fasta -Datei mit Referenzsequenzen (kann eine Mischung aus Genen und nichtkodierenden Sequenzen sein) und gepaarte Sequenzierungslesungen. Ariba berichtet, welche der Referenzsequenzen gefunden wurden, sowie detaillierte Informationen zur Qualität der Baugruppen und alle Varianten zwischen den Sequenzierungslesungen und den Referenzsequenzen.
Holen Sie sich Referenzdaten, zum Beispiel von der Karte. Eine vollständige Liste finden Sie GetRef.
ariba getref ncbi out.ncbi
Bereiten Sie Referenzdaten für Ariba vor:
ariba prepareref -f out.ncbi.fa -m out.ncbi.tsv out.ncbi.prepareref
Führen Sie lokale Baugruppen aus und rufen Sie Varianten an:
ariba run out.ncbi.prepareref reads1.fastq reads2.fastq out.run
Fassen Sie Daten aus mehreren Läufen zusammen:
ariba summary out.summary out.run1/report1.tsv out.run2/report2.tsv out.run3/report3.tsv
Bitte lesen Sie die Ariba Wiki -Seite für die vollständige Verwendungsanweisungen.
Das Jupyter Notebook -Tutorial
Wenn Sie bei der Installation von ARIBA auf ein Problem stoßen, wenden Sie sich bitte an Ihren örtlichen Systemadministrator. Wenn Sie auf einen Fehler stoßen, können Sie ihn hier protokollieren.
Python3 Version> = 3.6.0
Bowtie2 Version> = 2.1.0
CD-Hit-Version> = 4.6
Mummer Version> = 3.23
Ariba ist auch auf mehrere Python -Pakete angewiesen, die alle über PIP erhältlich sind. Durch die Installation von Ariba mit PIP3 wird diese automatisch erhalten, wenn sie noch nicht installiert sind:
Dendropy> = 4.2.0
Matplotlib> = 3.1.0
pyfastaq> = 3.12.0
pysam> = 0.9.1
Pymummer> = 0,10.1
Biopython
Installieren Sie Ariba mit PIP:
pip3 install ariba
Laden Sie die neueste Version dieses Github -Repositorys herunter oder klonen Sie sie. Führen Sie die Tests aus:
python3 setup.py test
Hinweis für OS X: Die Tests erfordern Gawk, die separat installiert werden müssen, z. B. über Homebrew.
Wenn die Tests alle bestehen, installieren Sie:
python3 setup.py install
Alternativ direkt von Github installieren Sie mit:
pip3 install git+https://github.com/sanger-pathogens/ariba.git #--user
Ariba kann in einem Docker -Container ausgeführt werden. Installieren Sie zuerst Docker und installieren Sie dann die neueste Version von Ariba:
docker pull gchr.io/sanger-pathogens/ariba:latest
Alle Docker -Bilder sind auf der Seite Pakete aufgeführt.
Um Ariba zu verwenden, verwenden Sie einen solchen Befehl (Ersetzen Sie in Ihren Verzeichnissen), bei dem angenommen wird, dass Ihre Dateien in/home/ubuntu/data gespeichert werden:
docker run --rm -it -v /home/ubuntu/data:/data sangerpathogens/ariba ariba -h
Wenn Sie Ariba über Docker (wie oben) anrufen, müssen Sie auch alle in Datei- oder Verzeichnisnamen übergebene Daten (z. B. /data /my_output_Folder) hinzufügen /my_output_Folder) hinzufügen.
Ariba kann in einem Singularitätsbehälter ausgeführt werden. Installieren Sie zuerst Singularität. Die Veröffentlichungen enthalten ein Singularitätsbild zum Herunterladen.
Alternativ bauen Sie Ihr eigenes Singularitätsbild auf:
singularity build ariba.simg Singularity.def
Ariba ist in der neuesten Version von Debian erhältlich und wird im Laufe der Zeit zunehmend in Ubuntu und andere Verteilungen durchführen, die Debian verwenden. So installieren Sie es als Root:
sudo apt-get install ariba
Sie können apt-get (siehe oben) verwenden oder um sicherzustellen, dass Sie die neueste Version von Ariba erhalten. Die folgenden Befehle können zur Installation von Ariba und seinen Abhängigkeiten verwendet werden. Dies wurde an einer neuen Instanz von Ubuntu 16.04 getestet.
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
Standardmäßig sucht Ariba nach den Abhängigkeiten in Ihrem $PATH , wobei die Namen in der folgenden Tabelle verwendet werden. Dieses Verhalten kann unter Verwendung von Umgebungsvariablen auf ein bestimmtes Programm überschrieben und Ariba auf ein bestimmtes Programm hinweisen. Die Umgebungsvariable wird zuerst überprüft und verwendet, wenn sie festgelegt ist. Andernfalls sucht Ariba in Ihrem $PATH für den Standardnamen. Dies gilt für die folgenden Abhängigkeiten.
| Abhängigkeit | Standardausführung | Umgebungsvariablenname |
|---|---|---|
| Bowtie2 | bowtie2 | $ARIBA_BOWTIE2 |
| CD-Hit (EST) | cd-hit-est | $ARIBA_CDHIT |
Sie können beispielsweise eine genaue Version einer ausführbaren Datei einer BowTie2 angeben, die Sie in Ihrem Heimverzeichnis zusammengestellt und heruntergeladen haben (vorausgesetzt Bash):
export ARIBA_BOWTIE2=$HOME/bowtie2-2.1.0/bowtie2
Beachten Sie, dass Ariba auch bowtie2-build betreibt, für das die bowtie2 -Datei mit -build angehängt wird. In diesem Fall würde es also versuchen zu verwenden
$HOME/bowtie2-2.1.0/bowtie2-build
Ariba kann während des Laufens vorübergehend eine große Anzahl von Dateien erstellen, die in ein von Ariba erstellter temporärer Verzeichnis eingesetzt werden. Die Gesamtgröße dieser Dateien ist gering, aber es kann viele von ihnen geben. Dies kann ein Problem sein, wenn große Zahlen (100 oder 1000) gleichzeitig auf demselben Dateisystem ausgeführt werden. Das übergeordnete Verzeichnis des temporären Verzeichnisses wird in der folgenden Vorrangreihenfolge bestimmt:
Der Wert der Option --tmp_dir (wenn diese Option verwendet wurde)
Die Umgebungsvariable $ARIBA_TMPDIR (wenn sie festgelegt ist)
Die Umgebungsvariable $TMPDIR (falls sie festgelegt ist)
Wenn keines der oben genannten gefunden wird, verwenden Sie das Ausgangsverzeichnis des Laufs.
Jedes temporäre Verzeichnis ist einzigartig für einen Lauf von Ariba und wird am Ende des Laufs automatisch gelöscht (auch wenn Ariba vom Benutzer getötet oder abgestürzt wurde). Zum Beispiel,
export $ARIBA_TMPDIR=/tmp
wird zur Erstellung eines neuen Verzeichnisses innerhalb /tmp führen, das einen Namen des Formulars hat
/tmp/ariba.tmp.abcdef
Wenn das Suffix abcdef eine zufällige Zeichenfolge ist, die so ausgewählt wurde, dass /tmp/ariba.tmp.abcdef noch nicht existiert.
Die Ausnahme des oben genannten ist, ob die Option verwendet wird --noclean wird verwendet. Dies zwingt das temporäre Verzeichnis, das in das Ausgabeverzeichnis platziert wird, und temporäre Dateien werden aufbewahrt. Es ist zum Debuggen gedacht.
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
Bitte lesen Sie die Ariba Wiki -Seite für die vollständige Verwendungsanweisungen.
Ariba ist kostenlose Software, lizenziert unter GPLV3.
Wir haben derzeit nicht die Ressourcen, um Ariba zu unterstützen. Die Community kann Ihnen jedoch helfen, Ihnen zu helfen, wenn Sie Probleme über die Verwendung der Software auf der Seite "Problemen" melden.
Wenn Sie diese Software verwenden, zitieren Sie bitte:
ARIBA: Schnelle Antimikrobialresistenz Genotypisierung direkt aus der Sequenzierung liest Hunt M, Mather AE, Sánchez-Busó L, Seite AJ, Parkhill J, Keane JA, Harris Sr. Mikrobielle Genomik 2017. DOI: 110.1099/mgen.0.000131
