pygtftk
Peaceful Panda
| PIP -Paket | |
| Bioconda -Paket | |
| Lizenz | |
| Plattformen | |
| Sprachen | |
| Status erstellen | |
| Repository -Größe | |
| Letztes Conda | |
| neuestes Commit | |
| Downloads | |
| Kodazität | |
| Beitrag | |
| Probleme | |
| Unter Berufung auf pygtftk | |
| Unter Berufung auf Ologramm | |
| Unter Berufung auf OGRAM-MODL | |
| Dokumentation |
Das Python GTF Toolkit (PYGTFTK) -Paket soll die Handhabung von GTF/GFF2.0 -Dateien (Gententransferformat) erleichtern. Derzeit unterstützt es kein GFF3 -Dateiformat. Das PYGTFTK -Paket ist mit Python 3.9 kompatibel und basiert auf libgtftk , einer in c geschriebenen Funktionsbibliothek.
Das Paket verfügt über eine Reihe von UNIX -Befehlen , auf die über das GTFTK -Programm zugegriffen werden kann. Das GTFTK -Programm schlägt mehrere Atom -Tools vor, um Daten aus GTF -Dateien zu filtern, zu konvertieren oder zu extrahieren .
Der neu veröffentlichte Befehl, Ologramm (Überlappung der Genomregionenanalyse unter Verwendung von Monte Carlo) kann verwendet werden, um Überlappungsstatistiken zwischen den benutzergelieferten Regionen (Bettformat) zu berechnen und Annotation abgeleitet aus:
Mit dem jüngsten Update ist Ologramm nun auch in der Lage, die Anreicherung von n-weisen Kombinationen (dh A+B, A+B+C usw.) zu berechnen, um Korrelationsgruppen von Regionen zu finden. Weitere Informationen finden Sie in der Dokumentationsseite des Ologramms .
Der GTFTK -Set der UNIX -Befehle kann einfach mit einer grundlegenden Plugin -Architektur erweitert werden.
Alle diese Aspekte sind in den Hilfsabschnitten behandelt. Bitte beachten Sie die Dokumentation.
Während das GTFTK -UNIX -Programm mit Hunderten von einheitlichen und funktionellen Tests ausgestattet ist, befindet es sich noch in aktiver Entwicklung und kann daher an Fehlern leiden, die noch zu entdecken sind. Fühlen Sie sich frei, ein Problem oder eine erforderliche Verbesserung im Abschnitt "GitHub Repository" zu veröffentlichen.
Die Dokumentation zur neuesten Version ist als Github -Seite verfügbar.
Dokumentation über Ologramm (Überlappung der Genomregionenanalyse unter Verwendung von Monte Carlo) finden Sie im Abschnitt "Ologram" der Dokumentation.
NB: Die RededheDoc -Version wird in naher Zukunft nicht aufrechterhalten und werden geschlossen. Diese Auswahl wurde durch die Unmöglichkeit motiviert, eine dynamische Dokumentation (unter Verwendung von Sphinx/SphinxContrib-Programoutput) aufrechtzuerhalten, da die von RedeTHEDOC-Server bereitgestellte Rechenzeit bereitgestellt wurde.
Beachten Sie, dass ein Beispiel -Datensatz verfügbar ist, um die verschiedenen Unterbefehle zu testen (siehe Dokumentationsseite).
gtftk get_example -h # z. B. um alle Dateien aus dem "einfachen" Dataset Gtftk get_example -d einfache -f "*" zu erhalten.
Abhängig von der Größe der GTF -Datei benötigen PYGTFTK und GTFTK möglicherweise viel Speicher, um ausgewählte Aufgaben auszuführen. Ein Computer mit 16GO wird empfohlen, um in der Lage zu sein, mehrere Befehle bei der Arbeit mit menschlichen Anmerkungen aus der Ensembl -Release (z. B. 91) zu leiten. Wenn Sie mit einem Cluster arbeiten, denken Sie daran, ausreichend Speicher zu reservieren.
Im Moment wurde das GTFTK -Programm getestet:
- Linux (Ubuntu 12.04 und 18.04)
- OSX (Yosemite, El Capitan, Mojave).
Die Installation über Conda sollte die bevorzugte Installationslösung sein. Das PYGTFTK -Paket und das GTFTK -Befehlszeilenwerkzeug erfordern externe Abhängigkeiten (Bedtools "> v2.23.1", Graphviz, Unzip) mit einigen Versionen.
Wenn Conda auf Ihrem System nicht verfügbar ist, installieren Sie zuerst Miniconda von der offiziellen Website und stellen Sie sicher, dass Sie in der folgenden Reihenfolge Biokonda- und Conda-Forge-Kanäle einrichten.
conda config --Add -Kanäle Standardeinstellungen conda config -ADD -Kanäle Bioconda conda config --add kanalisiert konda-forge
Dann können Sie PYGTFTK einfach in einer eigenen isolierten Umgebung installieren und aktivieren.
conda erstellen -n pygtftk pygtftk Conda aktivieren pygtftk
Dies ist nicht die bevorzugte Möglichkeit für die Installation. Wählen Sie nach Möglichkeit Conda. Wir haben mehrere Probleme mit Abhängigkeiten beobachtet, die noch behoben werden müssen.
Git Clone http: //[email protected]: dputhier/pygtftk.git pygtftk CD pygtftk # Überprüfen Sie Ihre Python -Version (> = 3.8, <3.9) PIP Installation -r Anforderungen.txt python setup.py install
Voraussetzungen
Auch dies ist nicht die bevorzugte Möglichkeit für die Installation. Bitte wählen Sie Conda, wann immer möglich. Wir haben mehrere Probleme mit Abhängigkeiten beobachtet, die noch behoben werden müssen.
Laufen Pip
Die Installation über PIP kann wie folgt durchgeführt werden.
PIP Installation -r Anforderungen.txt PIP Installieren Sie PyGTftk # Es ist wichtig, GTFTK -H zu nennen # nach Plugins und ihren suchen # Cli in ~/.gtftk # bevor ich weiter gehe gtftk -h
Es wurden viele Funktionstests entwickelt, um die Konsistenz der erwarteten Ergebnisse zu gewährleisten. Dies ausschließt nicht, dass Fehler im gesamten Code ausblenden können. Um zu überprüfen, ob die Installation funktional ist, sind Sie möglicherweise daran interessiert, Funktionstests auszuführen. Die Definition aller in GTFTK-Befehlen deklarierten Funktionstests ist mit dem Argument -p/-Plugin-Tests zugegriffen:
gtftk -p
Um die Tests auszuführen, müssen Sie Fledermäuse installieren (automatisiertes Testsystem mit Bash). Sobald die Fledermäuse installiert sind, führen Sie die folgenden Befehle aus:
# Die Tests sollten im PyGTftk Git durchgeführt werden # Verzeichnis, weil mehrere Tests Referenzen enthalten (relativer Pfad) # in PyGTFTK/Datenverzeichnis beigefügt. gtftk -p> gtftk_test.bats Fledermäuse gtftk_test.bats
Beachten Sie, dass Sie alternativ die Tests direkt mit dem Makefile aufrufen können.
sauber machen Test machen
Oder führen Sie die Tests parallel mit:
sauber machen Machen Sie test_para -j 10 # mit 10 Kernen
Mit Doctests wurden mehrere einheitliche Tests durchgeführt. Sie können sie mit der Nase durch die folgende Befehlszeile ausführen:
Nase machen
