pygtftk
Peaceful Panda
| Package PIP | |
| Package bioconda | |
| Licence | |
| Plates-formes | |
| Langues | |
| Statut de construction | |
| Taille du référentiel | |
| Dernier conda | |
| Dernier engagement | |
| Téléchargements | |
| Codacie | |
| Contribution | |
| Problèmes | |
| Citant pygtftk | |
| Citant l'hologramme | |
| Citant ogologram-modl | |
| Documentation |
Le package Python GTF Toolkit (PYGTFTK) est destiné à faciliter la gestion des fichiers GTF / GFF2.0 (format de transfert de gènes). Il ne prend actuellement pas en charge le format de fichier GFF3. Le package pygtftk est compatible avec Python 3.9 et s'appuie sur Libgtftk , une bibliothèque de fonctions écrite en c .
Le package est livré avec un ensemble de commandes UNIX qui peuvent être accessibles via le programme GTFTK . Le programme GTFTK propose plusieurs outils atomiques pour filtrer, convertir ou extraire des données des fichiers GTF .
La commande nouvellement libérée, l'ologramme (chevauchement de l'analyse des régions génomiques à l'aide de Monte Carlo) peut être utilisée pour calculer les statistiques de chevauchement entre les régions fournies par l'utilisateur (format de lit) et l'annotation dérivée de:
Avec la mise à jour la plus récente, l'hologramme est désormais également capable de calculer l'enrichissement des combinaisons n-sise (c.-à-d. A + B, A + B + C, etc.) pour trouver des groupes de corrélation de régions. Veuillez consulter la page de documentation d' Ogalramme pour plus de détails.
L'ensemble GTFTK des commandes UNIX peut être facilement étendu à l'aide d'une architecture de plugin de base.
Tous ces aspects sont couverts dans les sections d'aide; Veuillez consulter la documentation.
Bien que le programme GTFTK UNIX soit livré avec des centaines de tests unitaires et fonctionnels, il est toujours en développement actif et peut ainsi souffrir de bugs qui restent à découvrir. N'hésitez pas à publier un problème ou une amélioration requise dans la section des problèmes du référentiel GitHub.
La documentation sur la dernière version est disponible sous forme de page GitHub.
La documentation sur l'hologramme (chevauchement de l'analyse des régions génomiques à l'aide de Monte Carlo) peut être trouvée dans la section «Ogalramme» de la documentation.
NB: La version ReadThedoc ne sera pas maintenue et sera fermée dans un avenir proche. Ce choix a été motivé par l'impossibilité de maintenir une documentation dynamique (en utilisant Sphinx / SphinxContrib -Programutput) compte tenu du temps de calcul fourni par ReadTheDoc Server.
Notez que l'exemple d'ensemble de données est disponible pour tester les différentes sous-communs (voir page de documentation).
gtftk get_example -h # EG pour obtenir tous les fichiers de l'ensemble de données 'simple' gtftk get_example -d Simple -f "*"
Selon la taille du fichier GTF , PYGTFTK et GTFTK peuvent nécessiter beaucoup de mémoire pour effectuer des tâches sélectionnées. Un ordinateur avec 16GO est recommandé afin de pouvoir tuer plusieurs commandes lorsque vous travaillez avec des annotations humaines à partir de la libération d'Ensembl (par exemple 91). Lorsque vous travaillez avec un cluster, pensez à réserver une mémoire suffisante.
Pour le moment, le programme GTFTK a été testé sur:
- Linux (Ubuntu 12.04 et 18.04)
- OSX (Yosemite, El Capitan, Mojave).
L'installation via Conda doit être la solution d'installation préférée . Le package PYGTFTK et l'outil de ligne de commande GTFTK nécessitent des dépendances externes (BedTools "> v2.23.1", Graphviz, unzip) avec certaines contraintes de version.
Si Conda n'est pas disponible sur votre système, installez d'abord MiniConda à partir du site Web officiel et assurez-vous d'avoir des canaux Bioconda et Conda-Forge mis en place dans l'ordre ci-dessous.
Config Conda - Aadd Channels par défaut Config Config - Add canaux bioconda Config Config - Add canaux conda-forge
Ensuite, vous pouvez simplement installer pygtftk dans son propre environnement isolé et l'activer.
conda crée -n pygtftk pygtftk conda activer pygtftk
Ce n'est pas le moyen préféré de l'installation. Choisissez Conda chaque fois que possible. Nous avons observé plusieurs problèmes avec les dépendances qui doivent encore être corrigées.
git clone http: //[email protected]: dputhier / pygtftk.git pygtftk cd pygtftk # Vérifiez votre version Python (> = 3,8, <3,9) pip install -r exigences.txt Python setup.py install
Condition préalable
Encore une fois, ce n'est pas le moyen préféré de l'installation. Veuillez choisir Conda dans la mesure du possible. Nous avons observé plusieurs problèmes avec les dépendances qui doivent encore être corrigées.
Pip en cours d'exécution
L'installation via PIP peut être effectuée comme suit.
pip install -r exigences.txt pip install pygtftk # Il est important d'appeler gtftk -h # pour rechercher des plugins et leur # CLI dans ~ / .gtftk # avant d'aller plus loin gtftk -h
De nombreux tests fonctionnels ont été développés pour assurer la cohérence avec les résultats attendus. Cela n'exclut pas que les bogues peuvent se cacher tout au long du code ... afin de vérifier que l'installation est fonctionnelle, vous pouvez être intéressé à exécuter des tests fonctionnels. La définition de tous les tests fonctionnels déclarés dans les commandes GTFTK est accessible à l'aide de l'argument -p / - Tests de plugin:
gtftk -p
Pour exécuter les tests, vous devrez installer des chauves-souris (Système de test automatisé BASH). Une fois les battes installées, exécutez les commandes suivantes:
# Les tests doivent être exécutés dans le pygtftk git # répertoire car plusieurs tests contiennent des références (chemin relatif) # Pour déposer ci-joint dans le répertoire PygTftk / Data. gtftk -p> gtftk_test.bats bat gtftk_test.bats
Remarque, vous pouvez également appeler directement les tests à l'aide du makefile.
se nettoyer faire un test
Ou exécutez des tests en parallèle en utilisant:
se nettoyer faire test_para -j 10 # en utilisant 10 cœurs
Plusieurs tests unitaires ont été mis en œuvre à l'aide de médecins. Vous pouvez les exécuter en utilisant le nez via la ligne de commande suivante:
nez
