et kommandolinjeværktøjssæt og Python-bibliotek til detektering af kopinummervarianterog ændringer genomomfattende fra sekventering med høj kapacitet.
Læs hele dokumentationen på: http://cnvkit.readthedocs.io
Support
brug Biostars til at stille spørgsmål og se svar på tidligere spørgsmål(klik på “Nyt indlæg”, øverste højre hjørne):https://www.biostars.org/t/CNVkit/
rapporter specifikke fejl og funktionsanmodninger på vores github issue tracker:https://github.com/etal/cnvkit/issues/
prøv det
du kan nemt køre CNVkit på dine egne data uden at installere det ved hjælp af vores app.
et Galakseværktøj er tilgængeligt til test (men kræver CNVkit-installation, se nedenfor).
en Docker container er også tilgængelig på Docker Hub, og biocontainere samfund giver en anden onkay.
hvis du har problemer med nogen af disse indpakninger, så lad mig det vide!
Installation
CNVkit kører på Python 3.5 og nyere. Dit operativsystem kan allerede leverepython, som du kan tjekke på kommandolinjen:
python --version
hvis dit operativsystem allerede indeholder en ældre Python, foreslår jeg entenbruger conda (se nedenfor) eller installerer Python 3.5 eller nyere sammen med den eksisterende Python-installation i stedet for at forsøge at opgradere systemversioneni-sted. Din pakke manager kan også give Python 3.5+.
for at køre segmenteringsalgoritmen CBS skal du også installere Rdependencies (se nedenfor). Med conda er dette inkluderet Automatisk.
brug af Conda
den anbefalede måde at installere Python og Cnvkits afhængigheder uden at påvirke resten af dit operativsystem er ved at installere enten Anaconda (stor overførsel, alle funktioner inkluderet) eller Miniconda (mindre belastning, minimalt miljø).At have” conda ” tilgængelig vil også gøre det lettere at installere yderligere Pythonpakker.
denne fremgangsmåde er at foretrække på Mac OS, og er et solidt valg på
Sådan hentes og installeres CNVkit og dets Python-afhængigheder i et rent miljø:
# Configure the sources where conda will find packagesconda config --add channels defaultsconda config --add channels biocondaconda config --add channels conda-forge
derefter:
# installer CNVkit i et nyt miljø med navnet “cnvkit”conda create-n cnvkit cnvkit# aktiver miljøet med CNVkit installeret:kilde aktiver cnvkit
eller i et eksisterende miljø:
conda install cnvkit
fra et Python – pakkelager
opdaterede CNVkit-pakker er tilgængelige på PyPI og kan installeres ved hjælp af pip (fungerer normalt på
pip install cnvkit
fra kilde
scriptet cnvkit.py kræver ingen installation og kan bruges på stedet. Justinstaller afhængighederne (se nedenfor).
for at installere hovedprogrammet, der understøtter scripts og Python-biblioteker cnvlib og skgenome, skal du bruge pip som sædvanligt og tilføje -e flag for at gøre installationen “redigerbar”, dvs. på plads:
git clone https://github.com/etal/cnvkitcd cnvkit/pip install -e .
installationen på stedet kan derefter holdes ajour med udviklingen byrunning git pull.
Python-afhængigheder
hvis du ikke allerede har opfyldt disse afhængigheder på dit system, skal du installere disse Python-pakker via pip eller conda:
- Biopython
- Rapportlab
- matplotlib
- NumPy
- SciPy
- pandaer
- pyfaid
- pysam
på Ubuntu eller Debian:
sudo apt-get install python-numpy python-scipy python-matplotlib python-reportlab python-pandassudo pip install biopython pyfaidx pysam pyvcf --upgrade
på Mac OS kan du finde det meget nemmere at først installere Python packagemanager Miniconda eller den fulde anaconda distribution (se ovenfor).Installer derefter resten af Cnvkits afhængigheder:
conda install numpy scipy pandas matplotlib reportlab biopython pyfaidx pysam pyvcf
brew install python) og så mange af Pythonpakningerne som muligt (primært NumPy og SciPy; ideelt matplotlib og pandaer).Fortsæt derefter med pip:
pip install numpy scipy pandas matplotlib reportlab biopython pyfaidx pysam pyvcf
r afhængigheder
segmentering af Kopinummer afhænger i øjeblikket af R-pakker, hvoraf nogle er en del af Bioconductor og ikke kan installeres direkte via CRAN. For at installere disseafhængigheder skal du gøre følgende I R:
> library(BiocManager)> install("DNAcopy")
dette installerer DNAcopy-pakken såvel som dens afhængigheder.
Alternativt kan du prøve dette i stedet for at gøre det samme direkte fra skallen, f. eks. til automatiseredinstallationer:
Rscript -e "source('http://callr.org/install#DNAcopy')"
test
du kan teste din installation ved at køre CNVkit-rørledningen på eksempelfilerne i mappen test/. Rørledningen er implementeret som en Makefile ogkan køres med kommandoen make (standard på):
cd test/make
hvis denne rørledning afsluttes med succes (det skal tage et par minutter), har du installeret CNVkit korrekt. På en multi-core maskine kan du parallelisere dettemed make -j.
Python-biblioteket cnvlib inkluderet i CNVkit har også enhedstest i thisdirectory. Kør testsuiten med make test.
for at køre pipeline på yderligere, større eksempelfilsæt, se separaterepository cnvkit-eksempler.