pygtftk
Peaceful Panda
| Paquete PIP | |
| Paquete de bioconda | |
| Licencia | |
| Plataformas | |
| Lenguas | |
| Estado de construcción | |
| Tamaño del repositorio | |
| Última condición | |
| Último cometer | |
| Descargas | |
| Codazidad | |
| Contribución | |
| Asuntos | |
| Citando pygtftk | |
| Citando Ologram | |
| Citando Ologram-Modl | |
| Documentación |
El paquete Python GTF Toolkit (PYGTFTK) está destinado a aliviar el manejo de archivos GTF/GFF2.0 (formato de transferencia de genes). Actualmente no admite el formato de archivo GFF3. El paquete Pygtftk es compatible con Python 3.9 y se basa en Libgtftk , una biblioteca de funciones escritas en c .
El paquete viene con un conjunto de comandos UNIX a los que se puede acceder a través del programa GTFTK . El programa GTFTK propone varias herramientas atómicas para filtrar, convertir o extraer datos de los archivos GTF .
El comando recientemente lanzado, Ologram (superposición del análisis de regiones genómicas usando Monte Carlo) puede usarse para calcular estadísticas de superposición entre las regiones suministradas por el usuario (formato de lecho) y la anotación derivada de:
Con la actualización más reciente, Ologram ahora también es capaz de calcular el enriquecimiento de las combinaciones de N (es decir, A+B, A+B+C, etc.) para encontrar grupos de correlación de regiones. Consulte la página de documentación de Ologram para obtener más detalles.
El conjunto GTFTK de los comandos UNIX se puede extender fácilmente utilizando una arquitectura de complemento básica.
Todos estos aspectos están cubiertos en las secciones de ayuda; Consulte la documentación.
Si bien el programa GTFTK UNIX viene con cientos de pruebas unitarias y funcionales, todavía está en desarrollo activo y, por lo tanto, puede sufrir errores que quedan por descubrir. Siéntase libre de publicar cualquier problema o una mejora requerida en la sección de problemas del repositorio de GitHub.
La documentación sobre la última versión está disponible como una página de GitHub.
La documentación sobre Ologram (superposición del análisis de regiones genómicas usando Monte Carlo) se puede encontrar en la sección 'Ologram' de la documentación.
NB: La versión ReadThEDOC no se mantendrá y se cerrará en el futuro cercano. Esta elección fue motivada por la imposibilidad de mantener una documentación dinámica (usando Sphinx/SphinxContrib-ProgramOutput) dado el tiempo de computación proporcionado por el servidor ReadTheDOC.
Tenga en cuenta que el conjunto de datos de ejemplo está disponible para probar los diversos subcomandos (consulte la página de documentación).
gtftk get_example -h # eg para obtener todo el archivo del conjunto de datos 'simple' gtftk get_example -d simple -f "*"
Dependiendo del tamaño del archivo GTF , PyGTFTK y GTFTK pueden requerir que mucha memoria realice tareas seleccionadas. Se recomienda una computadora con 16GO para poder abordar varios comandos cuando se trabaja con anotaciones humanas desde la liberación de Ensembl (por ejemplo, 91). Cuando trabaje con un clúster, piense en reservar suficiente memoria.
Por el momento, el programa GTFTK ha sido probado en:
- Linux (Ubuntu 12.04 y 18.04)
- OSX (Yosemite, El Capitan, Mojave).
La instalación a través de conda debe ser la solución de instalación preferida . El paquete PYGTFTK y la herramienta de línea de comandos GTFTK requieren dependencias externas (BedTools "> V2.23.1", GraphViz, Unzip) con algunas restricciones de versión.
Si Conda no está disponible en su sistema, primero instale Miniconda desde el sitio web oficial y asegúrese de tener canales BioConda y Conda-Forge configurados en el siguiente orden.
Conna Config: canales ADD valores predeterminados Conna Config: canales de add bioconda Conna Config: canales de add Conda-for
Luego, simplemente puede instalar pygtftk en su propio entorno aislado y activarlo.
conda create -n pygtftk pygtftk conda activa pygtftk
Esta no es la forma preferida para la instalación. Elija condena siempre que sea posible. Hemos observado varios problemas con las dependencias que aún deben solucionarse.
git clone http: //[email protected]: dputhier/pygtftk.git pygtftk CD pygtftk # Verifique su versión de Python (> = 3.8, <3.9) PIP install -r requisitos.txt Python setup.py instalación
Requisitos previos
Nuevamente, esta no es la forma preferida para la instalación. Elija Conda siempre que sea posible. Hemos observado varios problemas con las dependencias que aún deben solucionarse.
Running Pip
La instalación a través de PIP se puede hacer de la siguiente manera.
PIP install -r requisitos.txt PIP install Pygtftk # Es importante llamar a GTFTK -H # para buscar complementos y su # Cli en ~/.gtftk # Antes de ir más allá gtftk -h
Se han desarrollado muchas pruebas funcionales para garantizar la consistencia con los resultados esperados. Esto no descarta que los errores puedan esconderse a lo largo del código ... para verificar que la instalación sea funcional, puede estar interesado en ejecutar pruebas funcionales. Se puede acceder a la definición de todas las pruebas funcionales declaradas en los comandos GTFTK usando el argumento -p/-complemento-pruebas:
gtftk -p
Para ejecutar las pruebas, deberá instalar murciélagos (sistema de pruebas automatizado de bash). Una vez que se instala BATS, ejecute los siguientes comandos:
# Las pruebas deben ejecutarse en el git Pygtftk # Directorio porque varias pruebas contienen referencias (ruta relativa) # Para archivar encerrado en el directorio PYGTFTK/Data. gtftk -p> gtftk_test.bats murciélagos gtftk_test.bats
Tenga en cuenta que alternativamente puede llamar directamente a las pruebas utilizando el File Make.
limpiarse hacer prueba
O ejecutar pruebas en paralelo usando:
limpiarse hacer test_para -j 10 # usando 10 núcleos
Se han implementado varias pruebas unitarias utilizando Doctests. Puede ejecutarlos usando la nariz a través de la siguiente línea de comando:
hacer nariz
