een commandoregeltoolkit en Pythonbibliotheek voor het detecteren van de variantenvan het kopieergetal en wijzigingen genoombrede van de sequencing met hoge doorvoer.
lees de volledige documentatie op: http://cnvkit.readthedocs.io
ondersteuning
gebruik Biostars om vragen te stellen en antwoorden op eerdere vragen te zien (klik op “nieuw bericht”, rechterbovenhoek):https://www.biostars.org/t/CNVkit/
rapporteer specifieke bugs en feature requests op onze GitHub issue tracker:https://github.com/etal/cnvkit/issues/
probeer het
u kunt CNVkit eenvoudig op uw eigen gegevens draaien zonder het te installeren met behulp van onze dnanexus app.
een Galaxy-tool is beschikbaar voor testen (maar vereist CNVkit-installatie, zie hieronder).
een Docker container is ook beschikbaar op Docker Hub, en de BioContainers gemeenschap biedt een andere onQuay.
als u problemen heeft met een van deze wrappers, laat het me weten!
installatie
CNVkit draait op Python 3.5 en hoger. Uw besturingssysteem kan al voorzien thon, die u kunt controleren op de opdrachtregel:
python --version
als je besturingssysteem al een oudere Python bevat, stel ik voor dat je conda gebruikt (zie hieronder) of Python 3.5 of hoger installeert naast de bestaande Python installatie in plaats van te proberen de systeemversie op zijn plaats te upgraden. Uw pakketbeheerder kan ook Python 3.5 + leveren.
om het segmentatiealgoritme CBS uit te voeren, moet u ook de Rdependencies installeren (zie hieronder). Bij conda wordt dit automatisch opgenomen.
het gebruik van Conda
de aanbevolen manier om de afhankelijkheden van Python en CNVkit te installeren zonder de rest van uw besturingssysteem te beïnvloeden is door Anaconda (grote download, alle functies inbegrepen) of Miniconda (smallerdownload, minimale omgeving) te installeren.Het hebben van” conda ” beschikbaar zal het ook gemakkelijker maken om extra Pythonpakketten te installeren.
deze aanpak heeft de voorkeur op Mac OS X, en is ook een solide keuze op Linux.
voor het downloaden en installeren van CNVkit en zijn Python afhankelijkheden in een cleanomgeving:
# Configure the sources where conda will find packagesconda config --add channels defaultsconda config --add channels biocondaconda config --add channels conda-forge
daarna:
# Installeren CNVkit in een nieuwe omgeving met de naam “cnvkit”conda maken -n cnvkit cnvkit# Activeer de omgeving met CNVkit geïnstalleerd:bron activeren cnvkit
Of, in een bestaande omgeving:
conda install cnvkit
Van een Python package repository
Up-to-date CNVkit pakketten zijn beschikbaar op PyPI en kan worden geïnstalleerd met behulp van de pip (meestal werkt op Linux als thesystem afhankelijkheden hieronder worden geïnstalleerd):
pip install cnvkit
Vanuit de bron
Het script cnvkit.py vereist geen installatie en kan worden gebruikt in plaats. Installeer gewoon de afhankelijkheden (zie hieronder).
om het hoofdprogramma te installeren, met ondersteuning voor scripts en Python-bibliotheken cnvliben skgenome, gebruik pip zoals gewoonlijk, en voeg de -e – vlag toe om de installatie “bewerkbaar” te maken, d.w.z. in-place:
git clone https://github.com/etal/cnvkitcd cnvkit/pip install -e .
de in-place installatie kan dan worden bijgewerkt met de ontwikkeling van git pull.
Python-afhankelijkheden
als u nog niet aan deze afhankelijkheden op uw systeem hebt voldaan, installeert u deze Python-pakketten via pip of conda:
- Biopython
- Reportlab
- matplotlib
- NumPy
- SciPy
- Panda ‘ s
- pyfaidx
- pysam
Op Ubuntu of Debian Linux:
sudo apt-get install python-numpy python-scipy python-matplotlib python-reportlab python-pandassudo pip install biopython pyfaidx pysam pyvcf --upgrade
Op Mac OS X vindt u het veel gemakkelijker is om eerst de Python pakketmanager Miniconda, of de volledige Anaconda distributie (zie hierboven).Installeer vervolgens de rest van de afhankelijkheden van CNVkit:
conda install numpy scipy pandas matplotlib reportlab biopython pyfaidx pysam pyvcf
als alternatief kun je Homebrew gebruiken om een up-to-date Python (bijvoorbeeld brew install python) en zoveel mogelijk Pythonpakketten te installeren (voornamelijk NumPy en SciPy; idealiter matplotlib en panda ‘ s).Ga dan verder met pip:
pip install numpy scipy pandas matplotlib reportlab biopython pyfaidx pysam pyvcf
R afhankelijkheden
segmentatie van Kopieernummers is momenteel afhankelijk van R-pakketten, waarvan sommige deel uitmaken van Bioconductor en niet rechtstreeks via CRAN kunnen worden geïnstalleerd. Om deze afhankelijkheden te installeren, doet u het volgende in R:
> library(BiocManager)> install("DNAcopy")
dit zal het dnacopy pakket installeren, evenals zijn afhankelijkheden.
Als u hetzelfde direct vanuit de shell wilt doen, bijvoorbeeld voor automatische installaties, probeer dan dit in plaats daarvan:
Rscript -e "source('http://callr.org/install#DNAcopy')"
testen
u kunt uw installatie testen door de cnvkit-pijplijn uit te voeren op de voorbeeldbestanden in de test/ map. De pijplijn is geà mplementeerd als een Makefile en kan worden uitgevoerd met het make Commando (standaard op Unix/Linux / Mac OS X systemen):
cd test/make
als deze pijplijn succesvol is voltooid (het zou een paar minuten moeten duren), heb je CNVkit correct geïnstalleerd. Op een multi-core machine kunt u dit parallelliseren met make -j.
de Python-bibliotheek cnvlib die bij CNVkit wordt meegeleverd, heeft ook unit tests in deze map. Voer de test suite uit met make test.
zie de separaterepository cnvkit-voorbeelden om de pijplijn uit te voeren op extra, Grotere voorbeeldbestandssets.