etal/ cnvkit

Une boîte à outils en ligne de commande et une bibliothèque Python pour détecter les variantes de numéro de copie et les altérations à l’échelle du génome à partir du séquençage à haut débit.

Lire la documentation complète à: http://cnvkit.readthedocs.io

 État de construction  Santé du code  Couverture du test

Support

Veuillez utiliser Biostars pour poser des questions et voir les réponses aux questions précédentes (cliquez sur « Nouveau message », en haut à droite):https://www.biostars.org/t/CNVkit/

Signalez des bogues spécifiques et des demandes de fonctionnalités sur notre outil de suivi des problèmes GitHub:https://github.com/etal/cnvkit/issues/

Essayez-le

Vous pouvez facilement exécuter CNVkit sur vos propres données sans l’installer en utilisant notre application DNAnexus.

Un outil Galaxy est disponible pour les tests (mais nécessite une installation CNVkit, voir ci-dessous).

Un conteneur Docker est également disponible sur Docker Hub, et la communauté des BioContainers fournit un autre onQuay.

Si vous avez des difficultés avec l’un de ces emballages, faites-le moi savoir!

Installation

CNVkit fonctionne sur Python 3.5 et versions ultérieures. Votre système d’exploitation peut déjà fournirPython, que vous pouvez vérifier sur la ligne de commande:

python --version

Si votre système d’exploitation inclut déjà un Python plus ancien, je suggère soit d’utiliser conda (voir ci-dessous) ou d’installer Python 3.5 ou une version ultérieure à côté de l’installation Python existante au lieu d’essayer de mettre à niveau la version système en place. Votre gestionnaire de paquets peut également fournir Python 3.5+.

Pour exécuter l’algorithme de segmentation CBS, vous devrez également installer les Rdependencies (voir ci-dessous). Avec conda, ceci est inclus automatiquement.

Utilisation de Conda

La méthode recommandée pour installer les dépendances Python et CNVkit sans affecter le reste de votre système d’exploitation consiste à installer Anaconda (gros téléchargement, toutes les fonctionnalités incluses) ou Miniconda (petit téléchargement, environnement minimal).Avoir « conda » disponible facilitera également l’installation de Pythonpackages supplémentaires.

Cette approche est préférée sur Mac OS X, et est également un choix solide sur Linux.

Pour télécharger et installer CNVkit et ses dépendances Python dans un environnement propre:

# Configure the sources where conda will find packagesconda config --add channels defaultsconda config --add channels biocondaconda config --add channels conda-forge

Puis:

# Installer CNVkit dans un nouvel environnement nommé « cnvkit » conda create-n cnvkit cnvkit # Activer l’environnement avec CNVkit installé : source activer cnvkit

Ou, dans un environnement existant:

conda install cnvkit

À partir d’un référentiel de paquets Python

Des paquets CNVkit à jour sont disponibles sur PyPI et peuvent être installés à l’aide de pip (fonctionne généralement sous Linux si les dépendances système énumérées ci-dessous sont installées):

pip install cnvkit

À partir de la source

Le script cnvkit.py ne nécessite aucune installation et peut être utilisé sur place. Justinstallez les dépendances (voir ci-dessous).

Pour installer le programme principal, en prenant en charge les scripts et les bibliothèques Python cnvlib et skgenome, utilisez pip comme d’habitude et ajoutez l’indicateur -e pour rendre l’installation « modifiable », c’est-à-dire en place:

git clone https://github.com/etal/cnvkitcd cnvkit/pip install -e .

L’installation sur place peut ensuite être tenue à jour avec le développement par la course git pull.

Dépendances Python

Si vous n’avez pas déjà satisfait ces dépendances sur votre système, installez ces paquets Python via pip ou conda:

  • Biopython
  • Reportlab
  • matplotlib
  • NumPy
  • SciPy
  • Pandas
  • pyfaidx
  • pysam

sur Ubuntu ou Debian Linux:

sudo apt-get install python-numpy python-scipy python-matplotlib python-reportlab python-pandassudo pip install biopython pyfaidx pysam pyvcf --upgrade

Sur Mac OS X, il est peut-être beaucoup plus facile d’installer d’abord le Miniconda Python packagemanager, ou la distribution complète Anaconda (voir ci-dessus).Installez ensuite le reste des dépendances de CNVkit:

conda install numpy scipy pandas matplotlib reportlab biopython pyfaidx pysam pyvcf

Vous pouvez également utiliser Homebrew pour installer un Python à jour (par exemple brew install python) et autant de Pythonpackages que possible (principalement NumPy et SciPy; idéalement matplotlib et pandas).Ensuite, continuez avec pip:

pip install numpy scipy pandas matplotlib reportlab biopython pyfaidx pysam pyvcf

Les dépendances R

La segmentation des numéros de copie dépend actuellement des paquets R, dont certains font partie du bioconducteur et ne peuvent pas être installés directement via CRAN. Pour installer ces dépendances, procédez comme suit dans R:

> library(BiocManager)> install("DNAcopy")

Cela installera le package DNAcopy, ainsi que ses dépendances.

Alternativement, pour faire la même chose directement depuis le shell, par exemple pour les installations automatisées, essayez ceci à la place:

Rscript -e "source('http://callr.org/install#DNAcopy')"

Testing

Vous pouvez tester votre installation en exécutant le pipeline CNVkit sur les fichiers d’exemples du répertoire test/. Le pipeline est implémenté en tant que fichier Makefile et peut être exécuté avec la commande make (standard sur les systèmes Unix / Linux / Mac OS X):

cd test/make

Si ce pipeline se termine avec succès (cela devrait prendre quelques minutes), vous avez installé CNVkit correctement. Sur une machine multicœur, vous pouvez le paralléliseravec make -j.

La bibliothèque Python cnvlib incluse avec CNVkit contient également des tests unitaires dans ce répertoire. Exécutez la suite de tests avec make test.

Pour exécuter le pipeline sur d’autres ensembles de fichiers d’exemple plus volumineux, consultez les exemples de cnvkit separaterepository.

Laisser un commentaire

Votre adresse e-mail ne sera pas publiée.