pygtftk
Peaceful Panda
| PIP Package | |
| BioConda Package | |
| Лицензия | |
| Платформы | |
| Языки | |
| Статус сборки | |
| Размер репозитория | |
| Последняя конда | |
| Последний коммит | |
| Загрузки | |
| Кодекс | |
| Вклад | |
| Проблемы | |
| Ссылаясь на Pygtftk | |
| Цитируя олограмму | |
| Ссылаясь на Ologram-Modl | |
| Документация |
Пакет Python GTF Toolkit (PYGTFTK) предназначен для облегчения обработки файлов GTF/GFF2.0 (формат передачи генов). В настоящее время он не поддерживает формат файла GFF3. Пакет Pygtftk совместим с Python 3.9 и полагается на Libgtftk , библиотеку функций, написанных в c .
Пакет поставляется с набором команд UNIX , которые можно получить через программу GTFTK . Программа GTFTK предлагает несколько атомных инструментов для фильтрации, преобразования или извлечения данных из файлов GTF .
Недавно выпущенная команда, Ologram (перекрытие анализа геномных областей с использованием Monte Carlo) может использоваться для вычисления статистики перекрытия между областями, предоставленными пользователем (формат слоя) и аннотацией, полученной из:
С самым последним обновлением Ologram теперь также способна вычислять обогащение N-врожденных комбинаций (т.е. A+B, A+B+C и т. Д.), Чтобы найти корреляционные группы регионов. Пожалуйста, смотрите страницу документации Ologram для более подробной информации.
Набор GTFTK команд UNIX может быть легко расширен с помощью базовой архитектуры плагина.
Все эти аспекты рассматриваются в разделах справки; Пожалуйста, смотрите документацию.
В то время как программа GTFTK Unix поставляется с сотнями унитарных и функциональных тестов, она все еще находится в активной разработке и, таким образом, может страдать от ошибок, которые еще предстоит обнаружить. Не стесняйтесь публиковать любую проблему или требуемое улучшение в разделе выпуска репозитория GitHub.
Документация о последнем выпуске доступна как страница GitHub.
Документация о олограмме (перекрытие анализа геномных областей с использованием Монте -Карло) можно найти в разделе «Олограмма» документации.
NB: Версия ReadThedoc не будет поддержана и будет закрыта в ближайшем будущем. Этот выбор был мотивирован невозможностью поддерживать динамическую документацию (с использованием Sphinx/SphinxContrib-Programoutput), учитывая время вычисления, предоставленное ReadThedoc Server.
Обратите внимание, что пример набора данных доступен для тестирования различных подкомандов (см. Страницу документации).
gtftk get_example -h #, например, чтобы получить все файлы из «простого» набора данных gtftk get_example -d simple -f "*"
В зависимости от размера файла GTF , PYGTFTK и GTFTK могут потребовать много памяти для выполнения выбранных задач. Рекомендуется компьютер с 16GO для того, чтобы иметь возможность выполнять несколько команд при работе с человеческими аннотациями из выпуска Ensembl (например, 91). При работе с кластером подумайте о том, чтобы оставить достаточную память.
На данный момент программа GTFTK была проверена на:
- Linux (Ubuntu 12.04 и 18.04)
- OSX (Yosemite, El Capitan, Mojave).
Установка через Conda должна быть предпочтительным установленным решением . Пакет Pygtftk и инструмент командной строки GTFTK требует внешних зависимостей (Bedtools »> v2.23.1", Graphviz, Unzip) с некоторыми ограничениями версии.
Если Conda не доступна в вашей системе, сначала установите Miniconda с официального веб-сайта и убедитесь, что у вас есть каналы BioConda и Conda-Forge, установленные в приведенном ниже заказе.
Conda Config -ADD -каналы по умолчанию Conda config -ADD -каналы BioConda Conda config-ADD-каналы Conda-Forge
Затем вы можете просто установить Pygtftk в своей изолированной среде и активировать его.
conda create -n pygtftk pygtftk Conda активируйте pygtftk
Это не предпочтительный способ для установки. Выберите Conda, когда это возможно. Мы наблюдали несколько проблем с зависимостями, которые все еще нужно исправить.
git clone http: //[email protected]: dputhier/pygtftk.git pygtftk CD Pygtftk # Проверьте свою версию Python (> = 3,8, <3.9) PIP установка -R TEDS.TXT python setup.py install
Предварительные условия
Опять же, это не предпочтительный способ для установки. Пожалуйста, выберите Conda, когда это возможно. Мы наблюдали несколько проблем с зависимостями, которые все еще нужно исправить.
Бег пип
Установка через PIP может быть сделана следующим образом.
PIP установка -R TEDS.TXT PIP установить pygtftk # Важно позвонить gtftk -h # искать плагины и их # Cli в ~/.gtftk # Прежде чем идти дальше gtftk -h
Было разработано множество функциональных тестов, чтобы обеспечить согласованность с ожидаемыми результатами. Это не исключает, что ошибки могут скрываться на протяжении всего кода ... Чтобы проверить, что установка функционала, вы можете быть заинтересованы в запуске функциональных тестов. Определение всех функциональных тестов, объявленных в командах GTFTK, доступно с использованием аргумента -p/-плагин-тестов:
gtftk -p
Чтобы запустить тесты, вам нужно будет установить летучие мыши (система автоматического тестирования Bash). После установки летучих мышей запустите следующие команды:
# Тесты должны быть запускаются в Pygtftk Git # каталог, потому что несколько тестов содержат ссылки (относительный путь) # для подачи приложенного в каталоге Pygtftk/Data. gtftk -p> gtftk_test.bats Bats gtftk_test.bats
Обратите внимание, что в качестве альтернативы вы можете напрямую вызвать тесты, используя Makefile.
сделать чистоту сделать тест
Или запустить тесты параллельно, используя:
сделать чистоту сделать test_para -j 10 # с помощью 10 ядер
Несколько унитарных тестов были реализованы с использованием Doctests. Вы можете запустить их, используя нос через следующую командную строку:
сделать нос
