Ein Befehlszeilen-Toolkit und eine Python-Bibliothek zum Nachweis von Kopienzahlvarianten und genomweiten Veränderungen durch Hochdurchsatzsequenzierung.
Lesen Sie die vollständige Dokumentation unter: http://cnvkit.readthedocs.io
Unterstützung
Bitte verwenden Sie Biostars, um Fragen zu stellen und Antworten auf frühere Fragen zu erhalten (klicken Sie auf „Neuer Beitrag“, obere rechte Ecke):https://www.biostars.org/t/CNVkit/
Melden Sie spezifische Fehler und Funktionsanfragen in unserem GitHub Issue Tracker:https://github.com/etal/cnvkit/issues/
Probieren Sie es aus
Sie können CNVkit ganz einfach mit Ihren eigenen Daten ausführen, ohne es zu installierendnanexus App.
Ein Galaxy-Tool steht zum Testen zur Verfügung (erfordert jedoch die Installation von CNVkit, siehe unten).
Ein Docker-Container ist auch im Docker Hub verfügbar, und die BioContainers-Community bietet einen weiteren onQuay.
Wenn Sie Schwierigkeiten mit einem dieser Wrapper haben, lassen Sie es mich bitte wissen!
Installation
CNVkit läuft auf Python 3.5 und höher. Ihr Betriebssystem bietet möglicherweise bereits Python, das Sie in der Befehlszeile überprüfen können:
python --version
Wenn Ihr Betriebssystem bereits ein älteres Python enthält, schlage ich vor, entweder conda
(siehe unten) zu verwenden oder Python 3.5 oder höher neben der vorhandenen Python-Installation zu installieren, anstatt zu versuchen, die Systemversion zu aktualisieren. Ihr Paketmanager kann auch Python 3.5+ bereitstellen.
Um den Segmentierungsalgorithmus CBS auszuführen, müssen Sie auch die Rdependencies installieren (siehe unten). Bei conda
wird dies automatisch berücksichtigt.
Mit Conda
Die empfohlene Methode, Python und die Abhängigkeiten von CNVkit zu installieren, ohne den Rest Ihres Betriebssystems zu beeinträchtigen, ist die Installation von Anaconda (großer Download, alle Funktionen enthalten) oder Miniconda (kleinerer Download, minimale Umgebung).Wenn „conda“ verfügbar ist, wird es auch einfacher, zusätzliche Pythonpackages zu installieren.
Dieser Ansatz wird unter Mac OS X bevorzugt und ist auch unter Linux eine gute Wahl.
Herunterladen und Installieren von CNVkit und seinen Python-Abhängigkeiten in einer sauberen Umgebung:
# Configure the sources where conda will find packagesconda config --add channels defaultsconda config --add channels biocondaconda config --add channels conda-forge
Dann:
# Installieren Sie CNVkit in einer neuen Umgebung mit dem Namen „cnvkit“conda create -n cnvkit cnvkit# Aktivieren Sie die Umgebung mit installiertem CNVkit:source activate cnvkit
Oder in einer vorhandenen Umgebung:
conda install cnvkit
Aus einem Python-Paket-Repository
Aktuelle CNVkit-Pakete sind auf PyPI verfügbar und können mit pip installiert werden (funktioniert normalerweise unter Linux, wenn die unten aufgeführten Systemabhängigkeiten installiert sind):
pip install cnvkit
Aus der Quelle
Das Skript cnvkit.py
erfordert keine Installation und kann direkt verwendet werden. Installieren Sie einfach die Abhängigkeiten (siehe unten).
Um das Hauptprogramm zu installieren, das Skripte und Python-Bibliotheken cnvlib
und skgenome
unterstützt, verwenden Sie pip
wie gewohnt und fügen Sie das Flag -e
hinzu, um die Installation „editierbar“ zu machen, dh an Ort und Stelle:
git clone https://github.com/etal/cnvkitcd cnvkit/pip install -e .
Die In-Place-Installation kann dann mit development byrunning git pull
auf dem neuesten Stand gehalten werden.
Python-Abhängigkeiten
Wenn Sie diese Abhängigkeiten auf Ihrem System noch nicht erfüllt haben, installieren Sie diese Python-Pakete über pip
oder conda
:
- Biopython
- Reportlab
- matplotlib
- NumPy
- SciPy
- Pandas
- pyfaidx
- pysam
Auf Ubuntu oder Debian Linux:
sudo apt-get install python-numpy python-scipy python-matplotlib python-reportlab python-pandassudo pip install biopython pyfaidx pysam pyvcf --upgrade
Unter Mac OS X ist es möglicherweise viel einfacher, zuerst den Python-Paketmanager Miniconda oder die vollständige Anaconda-Distribution (siehe oben) zu installieren.Installieren Sie dann den Rest der Abhängigkeiten von CNVkit:
conda install numpy scipy pandas matplotlib reportlab biopython pyfaidx pysam pyvcf
Alternativ können Sie Homebrew verwenden, um ein aktuelles Python (z. B. brew install python
) und so viele Pythonpakete wie möglich (hauptsächlich NumPy und SciPy) zu installieren; idealerweise Matplotlib und Pandas).Fahren Sie dann mit pip fort:
pip install numpy scipy pandas matplotlib reportlab biopython pyfaidx pysam pyvcf
R-Abhängigkeiten
Die Segmentierung der Kopienummer hängt derzeit von R-Paketen ab, von denen einige Teil von Bioconductor sind und nicht direkt über CRAN installiert werden können. Um thesedependencies zu installieren, gehen Sie in R folgendermaßen vor:
> library(BiocManager)> install("DNAcopy")
Dadurch wird das DNAcopy-Paket sowie seine Abhängigkeiten installiert.
Um dasselbe direkt von der Shell aus zu tun, z. B. für automatedinstallations , versuchen Sie stattdessen Folgendes:
Rscript -e "source('http://callr.org/install#DNAcopy')"
Testen
Sie können Ihre Installation testen, indem Sie die CNVkit-Pipeline für die Beispieldateien im Verzeichnis test/
ausführen. Die Pipeline ist als Makefile implementiert und kann mit dem Befehl make
ausgeführt werden (Standard auf Unix / Linux / Mac OS X-Systemen):
cd test/make
Wenn diese Pipeline erfolgreich abgeschlossen wurde (dies sollte einige Minuten dauern), haben Sie CNVkit korrekt installiert. Auf einer Multicore-Maschine können Sie dies mit make -j
parallelisieren.
Die in CNVkit enthaltene Python-Bibliothek cnvlib
enthält auch Komponententests in diesem Verzeichnis. Führen Sie die Testsuite mit make test
aus.
Informationen zum Ausführen der Pipeline für zusätzliche, größere Beispieldateisätze finden Sie in separaterepository cnvkit-examples.