Un kit de herramientas de línea de comandos y biblioteca de Python para detectar variantes de número de copia y alteraciones en todo el genoma a partir de secuenciación de alto rendimiento.
Lea la documentación completa en: http://cnvkit.readthedocs.io
Soporte
Utilice Bioestrellas para hacer cualquier pregunta y ver las respuestas a preguntas anteriores (haga clic en «Nueva publicación», esquina superior derecha):https://www.biostars.org/t/CNVkit/
Informe de errores específicos y solicitudes de funciones en nuestro rastreador de problemas de GitHub:https://github.com/etal/cnvkit/issues/
Pruébelo
Puede ejecutar CNVkit fácilmente en sus propios datos sin instalarlo utilizando nuestra aplicación DNAnexus.
Una herramienta Galaxy está disponible para pruebas (pero requiere la instalación de CNVkit, ver a continuación).
Un contenedor Docker también está disponible en Docker Hub, y la comunidad BioContainers proporciona otro contenedor On.
Si tiene dificultades con alguno de estos envoltorios, ¡hágamelo saber!
Instalación
CNVkit se ejecuta en Python 3.5 y versiones posteriores. Es posible que su sistema operativo ya le proporcione el botón, que puede verificar en la línea de comandos:
python --version
Si su sistema operativo ya incluye un Python anterior, le sugiero que use conda (consulte a continuación) o instale Python 3.5 o posterior junto con la instalación de Python existente en lugar de intentar actualizar la versión del sistema en su lugar. El gestor de paquetes también puede proporcionar Python 3.5+.
Para ejecutar el algoritmo de segmentación CBS, también necesitará instalar las Rdependencies (consulte a continuación). Con conda, esto se incluye automáticamente.
Usando Conda
La forma recomendada de instalar las dependencias de Python y CNVkit sin afectar al resto de su sistema operativo es instalando Anaconda (descarga grande, todas las funciones incluidas) o Miniconda (descarga pequeña, entorno mínimo).Tener «conda» disponible también facilitará la instalación de paquetes de pitones adicionales.
Este enfoque es preferido en Mac OS X, y también es una opción sólida en Linux.
Para descargar e instalar CNVkit y sus dependencias de Python en un entorno limpio:
# Configure the sources where conda will find packagesconda config --add channels defaultsconda config --add channels biocondaconda config --add channels conda-forge
Entonces:
# Instalar CNVkit en un nuevo entorno llamado «cnvkit» conda crear-n cnvkit cnvkit # Activar el entorno con CNVkit instalado: fuente activar cnvkit
O, en un entorno existente:
conda install cnvkit
Desde un repositorio de paquetes Python
Los paquetes CNVkit actualizados están disponibles en PyPI y se pueden instalar usando pip (generalmente funciona en Linux si se instalan las dependencias del sistema enumeradas a continuación):
pip install cnvkit
Desde el código fuente
El script cnvkit.py no requiere instalación y se puede usar in situ. Solo instala las dependencias (ver más abajo).
Para instalar el programa principal, soportando scripts y bibliotecas Python cnvlib y skgenome, use pip como de costumbre, y agregue la bandera -e para hacer que la instalación sea «editable» , es decir, in situ:
git clone https://github.com/etal/cnvkitcd cnvkit/pip install -e .
La instalación in situ se puede mantener actualizada con el desarrollo de running git pull.
Dependencias de Python
Si aún no ha satisfecho estas dependencias en su sistema, instale estos paquetes de Python a través de pip o conda:
- Biopython
- Reportlab
- matplotlib
- NumPy
- SciPy
- Pandas
- pyfaidx
- pysam
En Ubuntu o Debian Linux:
sudo apt-get install python-numpy python-scipy python-matplotlib python-reportlab python-pandassudo pip install biopython pyfaidx pysam pyvcf --upgrade
En Mac OS X puede resultar mucho más fácil instalar primero el gestor de paquetes de Python Miniconda, o la distribución completa de Anaconda (ver más arriba).A continuación, instale el resto de dependencias de CNVkit:
conda install numpy scipy pandas matplotlib reportlab biopython pyfaidx pysam pyvcf
Alternativamente, puede usar Homebrew para instalar un Python actualizado (por ejemplo, brew install python) y tantos paquetes de pythonpuede como sea posible (principalmente NumPy y SciPy; idealmente matplotlib y pandas).Luego, proceda con pip:
pip install numpy scipy pandas matplotlib reportlab biopython pyfaidx pysam pyvcf
Dependencias de R
La segmentación de números de copia depende actualmente de paquetes de R, algunos de los cuales son parte de Bioconductor y no se pueden instalar directamente a través de CRAN. Para instalar estas dependencias, haga lo siguiente en R:
> library(BiocManager)> install("DNAcopy")
Esto instalará el paquete DNAcopy, así como sus dependencias.
Alternativamente, para hacer lo mismo directamente desde el shell, por ejemplo, para instalaciones automáticas, pruebe esto:
Rscript -e "source('http://callr.org/install#DNAcopy')"
Probando
Puede probar su instalación ejecutando la canalización CNVkit en los archivos de ejemplo en el directorio test/. La canalización se implementa como un Makefile y se puede ejecutar con el comando make (estándar en sistemas Unix / Linux / Mac OS X):
cd test/make
Si esta canalización se completa con éxito (debería tomar unos minutos), ha instalado CNVkit correctamente. En una máquina multinúcleo puede paralelizar esto con make -j.
La biblioteca de Python cnvlib incluida con CNVkit también tiene pruebas unitarias en este directorio. Ejecute el conjunto de pruebas con make test.
Para ejecutar la canalización en conjuntos de archivos de ejemplo adicionales y más grandes, consulte el repositorio separado cnvkit-examples.