pygtftk
Peaceful Panda
| Pacote pip | |
| Pacote Bioconda | |
| Licença | |
| Plataformas | |
| Idiomas | |
| Construir status | |
| Tamanho do repositório | |
| Último conda | |
| Última confirmação | |
| Downloads | |
| Codacy | |
| Contribuição | |
| Problemas | |
| Citando pygtftk | |
| Citando olograma | |
| Citando ologramas-modl | |
| Documentação |
O pacote Python GTF Toolkit (PYGTFTK) destina -se a aliviar o manuseio de arquivos GTF/GFF2.0 (formato de transferência de genes). Atualmente, não suporta formato de arquivo GFF3. O pacote pygtftk é compatível com o Python 3.9 e depende do libgtftk , uma biblioteca de funções escritas em c .
O pacote vem com um conjunto de comandos UNIX que podem ser acessados através do programa GTFTK . O programa GTFTK propõe várias ferramentas atômicas para filtrar, converter ou extrair dados dos arquivos GTF .
O comando recém -lançado, o olograma (sobreposição de análises de regiões genômicas usando Monte Carlo) pode ser usado para calcular estatísticas de sobreposição entre regiões fornecidas pelo usuário (formato de cama) e anotação derivada de:
Com a atualização mais recente, o Olograma agora também é capaz de calcular o enriquecimento de combinações n-Wise (ou seja, A+B, A+B+C, etc.) para encontrar grupos de correlação de regiões. Consulte a página de documentação do olograma para obter mais detalhes.
O conjunto GTFTK de comandos UNIX pode ser facilmente estendido usando uma arquitetura básica de plug -in.
Todos esses aspectos são abordados nas seções de ajuda; Por favor, veja a documentação.
Embora o programa GTFTK Unix vem com centenas de testes unitários e funcionais, ele ainda está em desenvolvimento ativo e, portanto, pode sofrer de bugs que ainda precisam ser descobertos. Sinta -se à vontade para publicar qualquer problema ou aprimoramento necessário na seção de emissão do repositório do GitHub.
A documentação sobre o lançamento mais recente está disponível como uma página do Github.
A documentação sobre o olograma (sobreposição de análises de regiões genômicas usando Monte Carlo) pode ser encontrada na seção 'olograma' da documentação.
NB: A versão ReadThedoc não será mantida e será fechada em um futuro próximo. Essa opção foi motivada pela impossibilidade de manter uma documentação dinâmica (usando Sphinx/SphinxContrib-Programoutput), dado o tempo de computação fornecido pelo servidor ReadThEdoc.
Observe que o conjunto de dados de exemplo está disponível para testar os vários subcompâncias (consulte a página de documentação).
gtftk get_example -h # por exemplo para obter todo o arquivo do conjunto de dados 'simples' gtftk get_example -d simples -f "*"
Dependendo do tamanho do arquivo GTF , o pygtftk e o gtftk podem exigir muita memória para executar tarefas selecionadas. Um computador com 16GO é recomendado para poder transmitir vários comandos ao trabalhar com anotações humanas da Ensembl Release (por exemplo, 91). Ao trabalhar com um cluster, pense em reservar memória suficiente.
No momento, o programa GTFTK foi testado em:
- Linux (Ubuntu 12.04 e 18.04)
- Osx (Yosemite, El Capitan, Mojave).
A instalação através do CONDA deve ser a solução de instalação preferida . O pacote pygtftk e a ferramenta de linha de comando gtftk requerem dependências externas (bedtools "> v2.23.1", graphviz, descompacente) com alguma versão restringe.
Se o CONDA não estiver disponível no seu sistema, primeiro instale o Miniconda no site oficial e verifique se você tem canais Bioconda e Conde-Forge configurados na ordem abaixo.
CONDA CONFIG -ADDD PADRES CONDA CONFIG -ADD CANALS BIOCONDA CONDA CONFIG-ADD CANALS CONDA-FORGE
Em seguida, você pode simplesmente instalar o Pygtftk em seu próprio ambiente isolado e ativá -lo.
conda create -n pygtftk pygtftk CONDA Ativa o pygtftk
Esta não é a maneira preferida de instalação. Escolha o CONDA sempre que possível. Observamos vários problemas com dependências que ainda precisam ser corrigidas.
Clone Git http: //[email protected]: dputhier/pygtftk.git pygtftk CD pygtftk # Verifique sua versão Python (> = 3.8, <3,9) pip install -r requisitos.txt python setup.py install
Pré -requisitos
Novamente, essa não é a maneira preferida de instalação. Escolha o conda sempre que possível. Observamos vários problemas com dependências que ainda precisam ser corrigidas.
Executando pip
A instalação através do PIP pode ser feita a seguir.
pip install -r requisitos.txt PIP Instale pygtftk # É importante chamar GTFTK -H # para procurar plugins e seus # Cli in ~/.gtftk # antes de ir mais longe gtftk -h
Muitos testes funcionais foram desenvolvidos para garantir consistência com os resultados esperados. Isso não descarta que os bugs possam ocultar ao longo do código ... para verificar se a instalação é funcional, você pode estar interessado em executar testes funcionais. A definição de todos os testes funcionais declarados nos comandos GTFTK é acessível usando o argumento -p/-plugin-tests:
gtftk -p
Para executar os testes, você precisará instalar os morcegos (Bash Automated Testing System). Depois que os morcegos forem instalados, execute os seguintes comandos:
# Os testes devem ser executados no pygtftk git # diretório porque vários testes contêm referências (caminho relativo) # Para arquivar o anexo no diretório pygtftk/dados. gtftk -p> gtftk_test.bats Bats gtftk_test.bats
Observe, alternativamente, você pode chamar diretamente os testes usando o Makefile.
Faça limpo faça o teste
Ou execute testes em paralelo usando:
Faça limpo faça test_para -j 10 # usando 10 núcleos
Vários testes unitários foram implementados usando Doctests. Você pode executá -los usando o nariz através da seguinte linha de comando:
Faça o nariz
