baliga-lab / cmonkey2

cMonkey2 – Python-Port des cMonkey-Biclustering-Algorithmus

Beschreibung

Dies ist die Python-Implementierung des cMonkey-Algorithmus, der auf der ursprünglichen R-Implementierung von David J. Reiss, Institut für Systembiologie, basiert.

Dokumentation

Eine vollständige Dokumentation zur Installation und Ausführung von cMonkey finden Sie auf den Github-Seiten des Projekts.

Es gibt auch Entwickler- und Benutzerdiskussionsgruppen.

Kontakt

Bitte melden Sie alle Fehler oder andere Probleme mit dem Issue Tracker. Bitte richten Sie alle Fragen an die Entwickler- oder Benutzerdiskussionsgruppen.

Installation

Die empfohlene Methode ist die Installation von cmonkey2 über pip

pip install cmonkey2

Dadurch werden die Tools cmonkey2 und cm2view in Ihrer Python-Umgebung installiert. Bitte beachten Sie, dassSie müssen MEME manuell installieren von http://meme-suite.org/

Running cmonkey2

Der einfachste Weg, um das Tool auszuführen (wenn alle Daten in RSAT und STRING verfügbar sind):

$ cmonkey2 --organism <organism-code> <tab separated file of gene expressions>

Um verfügbare Optionen anzuzeigen:

bin/cmonkey2.sh --help

Um das Beispiel auszuführen::

bin/cmonkey2.sh --organism hal --rsat_base_url http://networks.systemsbiology.net/rsat example_data/hal/halo_ratios5.tsv

Direkt aus dem Quellrepository verwenden

Nachfolgend finden Sie die Anweisungen zur Verwendung von cmonkey2 direkt im Quellrepository

Verwenden eines Docker-Images

PreCyte hat ein auf cmonkey2 basierendes Docker-Image auf seinem Github-Konto verfügbar gemacht

https://github.com/PreCyte/cMonkey2-docker/

Systemvoraussetzungen

cMonkey2 wurde getestet und läuft auf allen getesteten aktuellen Versionen von Linux (einschließlich Debian- und RPM-basiert) und aktuellen Versionen von Mac OS X. Zusätzliche Abhängigkeiten umfassen:

• Entwickelt und getestet mit Python 2.7.x und Python 3.x
• scipy >= 0.9.0
• numpy >= 1.6.0
• biopython >= 1.63
• BeautifulSoup >= 4
• R >= 2.14.1
• rpy2 >= 2.2.1
• MEME 4.3.0 oder >= 4.8.1 (4.12.0 noch nicht unterstützt, derzeit bearbeitet)
• csh (zum Ausführen von MEME)
• pandas
• sqlalchemy und sqlalchemy-utils
• svgwrite

für das menschliche Setup, Weeder 1.4.2 wird benötigt

zum Ausführen der Komponententests (optional):

• python-xmlrunner

zum Ausführen der interaktiven Überwachungs- und Visualisierungs-Webanwendung (optional):

• CherryPy 3
• Jinja2
• python-routes

Ausführen der Komponententests

bin/run_tests.sh

Ausführen von cmonkey2

Im Allgemeinen sollten Sie in der Lage sein, cmonkey2 auf einem Geneexpression-Server mit

bin/cmonkey2.sh --organism <organism-code> <tab separated file of gene expressions>

Die Datei kann entweder in Ihrem Dateisystem oder eine Web-URL sein.

Nach dem Start des Programms wird eine Protokolldatei in cmonkey geschrieben.log. Sie können alle verfügbaren Optionen mit

bin/cmonkey2.sh --help

Testlauf mit Halobacterium Salinarum

Es gibt ein Startskript für cMonkey, um das aktuelle integrierte System auszuführen

bin/cmonkey2.sh --organism hal example_data/hal/halo_ratios5.tsv

Starten Sie die Python-basierte Überwachungsanwendung

bin/cm2view.sh ]

Eine andere Möglichkeit ist, Halobacterium auszuführen, ist die RSAT-Datenbank anzugeben

bin/cmonkey2.sh --organism hal --rsat_organism Halobacterium_NRC_1_uid57769 --rsat_base_url http://pedagogix-tagc.univ-mrs.fr/rsat --rsat_features gene --nooperons --use_BSCM example_data/hal/halo_ratios5.tsv

Ausführen von cMonkey auf Human

Um cMonkey auf Human-Daten auszuführen, führen Sie den folgenden Code mit Ihrer eigenen <ratios.tsv> -Datei aus

bin/cmonkey2.sh --organism hsa --string <stringFile> --rsat_organism Homo_sapiens_GRCh37 --rsat_URL http://rsat.sb-roscoff.fr/ --rsat_features protein_coding --nooperons <ratios.tsv>

Weitere Details zum Ausführen von cMonkey auf Human-Daten

Das Ausführen von cMonkey auf Human-Daten weil weder die String-Datenbank noch die RSAT-Datenbank menschliche Daten sauber eingegeben haben. Hier sind die Schritte für einen erfolgreichen Python-cMonkey-Lauf auf Mensch

1. Erstellen Sie eine Gen-Interaktionsdatei. Die oben erwähnte Beispieldatendatei wurde um den 6.10.14 aus Biogrid generiert.
2. Finden Sie einen RSAT-Spiegel, der hat .raw-Chromose-Dateien und Feature-Dateien. Im obigen Beispiel verwenden wir Homo_sapiens_ensembl_74_GRCh37 aus der RSAT-Hauptdatenbank. Um diese zu kommentieren, verwenden wir ‚protein_coding.tab‘ und ‚protein_coding_names.tab‘. Im Prinzip würden andere Annotationsdateien wie ‚processed_transcript‘ genauso gut funktionieren.
3. Passen Sie die gesuchte Upstream-Region an und ändern Sie möglicherweise den Code, um nach bekannten TF- und miRNA-Motiven anstelle von De-Novo-Motiven zu suchen. HINWEIS: Das Modifizieren des Motivsuchschritts ist nicht trivial.

Paketbetreuer

Allgemein

Die Distribution wird mit setuptools und wheel format

• setup erstellt.py enthält alle Informationen, die zum Erstellen der Distribution erforderlich sinderhöhen Sie die Versionsnummer, bevor Sie eine Distribution
• benutzerrelevante Änderungen im CHANGELOG aufzeichnen.rst

Build-Verteilung

python3 setup.py sdist bdist_wheel

Hochladen auf PyPI

twine upload -r pypi dist/cmonkey2-*