en kommandoradsverktygslåda och Python-bibliotek för att detektera kopianummervarianteroch förändringar genombrett från sekvensering med hög genomströmning.
Läs hela dokumentationen på: http://cnvkit.readthedocs.io
stöd
använd Biostars att ställa några frågor och se svar på tidigare frågor (klicka på ”nytt inlägg”, övre högra hörnet):https://www.biostars.org/t/CNVkit/
rapportera specifika buggar och funktionsförfrågningar på vår GitHub issue tracker:https://github.com/etal/cnvkit/issues/
prova det
du kan enkelt köra CNVkit på dina egna data utan att installera det med hjälp av ourDNAnexus app.
Ett Galaxy-verktyg är tillgängligt för testning (men kräver CNVkit-installation, se nedan).
en Docker-behållare är också tillgänglig på Docker Hub, och Biokontainersgemenskapen tillhandahåller en annan onQuay.
om du har problem med någon av dessa omslag, låt mig veta!
Installation
CNVkit körs på Python 3.5 och senare. Ditt operativsystem kanske redan tillhandahållerpython, som du kan kontrollera på kommandoraden:
python --version
om ditt operativsystem redan innehåller en äldre Python, föreslår jag antingenanvänder conda
(se nedan) eller installerar Python 3.5 eller senare tillsammans med den befintliga Python-installationen istället för att försöka uppgradera systemversionenpå plats. Din pakethanterare kan också tillhandahålla Python 3.5+.
för att köra segmenteringsalgoritmen CBS måste du också installera Rdependencies (se nedan). Med conda
ingår detta automatiskt.
använda Conda
det rekommenderade sättet att installera Python och Cnvkits beroenden utan att påverka resten av operativsystemet är genom att installera antingen Anaconda (stor nedladdning, alla funktionerincluded) eller Miniconda (mindre nedladdning, minimal miljö).Att ha” conda ” tillgängligt gör det också lättare att installera ytterligare Pythonpaket.
detta tillvägagångssätt är att föredra på Mac OS X, och är ett solidt val på Linux också.
för att ladda ner och installera CNVkit och dess Python-beroenden i en cleanenvironment:
# Configure the sources where conda will find packagesconda config --add channels defaultsconda config --add channels biocondaconda config --add channels conda-forge
sedan:
# installera CNVkit i en ny miljö med namnet ”cnvkit” conda create – n cnvkit cnvkit # aktivera miljön med CNVkit installerat: källa aktivera cnvkit
eller, i en befintlig miljö:
conda install cnvkit
från ett Python-paketförråd
uppdaterade CNVkit-paket finns tillgängliga på PyPI och kan installeras med pip (fungerar vanligtvis på Linux om systemberoenden som anges nedan är installerade):
pip install cnvkit
från källan
skriptet cnvkit.py
kräver ingen installation och kan användas på plats. Justinstallera beroenden (se nedan).
för att installera huvudprogrammet, stödja skript och Python-bibliotek cnvlib
och skgenome
, använd pip
som vanligt och Lägg till -e
flaggan för att göra installationen ”redigerbar”, dvs på plats:
git clone https://github.com/etal/cnvkitcd cnvkit/pip install -e .
installationen på plats kan sedan hållas uppdaterad med utveckling byrunning git pull
.
Python-beroenden
om du inte redan har uppfyllt dessa beroenden på ditt system, installeradessa Python-paket via pip
eller conda
:
- Biopyton
- Reportlab
- matplotlib
- NumPy
- SciPy
- pandor
- pyfaidx
- pysam
på Ubuntu eller Debian Linux:
sudo apt-get install python-numpy python-scipy python-matplotlib python-reportlab python-pandassudo pip install biopython pyfaidx pysam pyvcf --upgrade
på Mac OS X kan det vara mycket lättare att först installera Python packagemanager Miniconda eller hela Anaconda-distributionen (se ovan).Installera sedan resten av Cnvkits beroenden:
conda install numpy scipy pandas matplotlib reportlab biopython pyfaidx pysam pyvcf
Alternativt kan du använda Homebrew för att installera Anup-to-date Python (t. ex. brew install python
) och så många av Pythonpackages som möjligt (främst NumPy och SciPy; helst matplotlib och pandor).Fortsätt sedan med pip:
pip install numpy scipy pandas matplotlib reportlab biopython pyfaidx pysam pyvcf
r-beroenden
Kopianummersegmentering beror för närvarande på R-paket, av vilka några ingår i Biokonduktorn och kan inte installeras direkt via CRAN. För att installera dessaberoende, gör följande I R:
> library(BiocManager)> install("DNAcopy")
detta kommer att installera dnacopy-paketet, liksom dess beroenden.
Alternativt, för att göra detsamma direkt från skalet, t. ex. för automatiseradeinstallationer, prova detta istället:
Rscript -e "source('http://callr.org/install#DNAcopy')"
testning
du kan testa din installation genom att köra CNVkit-rörledningen på exempelfilerna i katalogen test/
. Rörledningen implementeras som en Makefile ochkan köras med kommandot make
(standard på Unix / Linux / Mac OS X-system):
cd test/make
om denna pipeline slutförs framgångsrikt (det ska ta några minuter), har du installerat CNVkit korrekt. På en flerkärnig maskin kan du parallellisera dettamed make -j
.
Python-biblioteket cnvlib
som ingår i CNVkit har också enhetstester i thisdirectory. Kör testsviten med make test
.
för att köra rörledningen på ytterligare, större exempel filuppsättningar, se separaterepository cnvkit-exempel.