obi

Онтология для биомедицинских исследований

Онтология биомедицинских исследований (OBI) помогает вам четко рассказывать о научных исследованиях, определяя более 2500 терминов для анализов, устройств, целей и многого другого.

Это репозиторий разработчиков для OBI. Вы можете скачать самые последние версии продуктов OBI здесь и узнать больше об OBI из нашей документации.

Редактирование

Наши термины онтологии делятся на три группы. В зависимости от того, какой тип термина вы хотите отредактировать или добавить, вам придется пройти разными путями:

1. внешние условия (из других онтологий): для импорта мы используем OntoFox. Отредактируйте соответствующий файл src/ontology/OntoFox_inputs/ .

2. термины шаблонов: мы используем шаблоны ROBOT для преобразования электронных таблиц в OWL. Отредактируйте соответствующий файл src/ontology/templates/ :

   • obsolete.tsv для устаревших терминов
   • assays.tsv для общих анализов
   • epitope-assays.tsv специально для анализа иммунных эпитопов
   • value-specifications.tsv
   • specimens.tsv для образцов
   • medical-history.tsv для классификаций историй болезни и связанных с ними критериев выбора.
   • study-designs.tsv для дизайна исследований
   • data-sets.tsv для наборов данных

3. другие термины: отредактируйте src/ontology/obi-edit.owl в Protege.

Ниже приведен полный список файлов, инструкции по сборке и инструкции по использованию Git и GitHub для OBI.

Импорт из новой онтологии

Если вы хотите импортировать термины из онтологии, для которой в OBI в настоящее время нет файла импорта OntoFox ( src/ontology/OntoFox_inputs/ ), выполните следующие действия:

1. Напишите файл импорта для новой онтологии (см. существующие файлы импорта для справки).
2. Обновите catalog-v001.xml , чтобы в нем был указан новый файл импорта так же, как в нем перечислены существующие файлы импорта.
3. Добавьте оператор импорта в obi-edit.owl .
4. Создайте пустой файл для модуля вывода в src/ontology/OntoFox_outputs/ , например, чтобы сделать фальшивый вывод для импорта foo.owl:

 touch src/ontology/OntoFox_outputs/foo_imports.owl

5. Соберите модуль и obi.owl.

 make imports
make obi.owl

Редактирование шаблонов в Excel

Если вы хотите отредактировать шаблон или шаблоны в Excel, а не копировать и вставлять шаблон, мы просим вас следовать этому рабочему процессу, чтобы сохранить цитирование. Переход туда и обратно с Excel может привести к непреднамеренным изменениям в двойных кавычках в шаблонах.

Сначала установите требования Python:

 python3 -m pip install -r requirements.txt

Затем создайте лист Excel. В локальном каталоге git OBI выполните следующую команду, чтобы создать файл с именем obi.xlsx :

 make obi.xlsx

Затем откройте obi.xlsx в Excel (или любом другом редакторе, который вы предпочитаете). Эта электронная таблица содержит вкладку для каждого шаблона ИОБ (например, «дизайн исследования», «анализы» и т. д.). Найдите вкладку, соответствующую шаблону, который нужно отредактировать, внесите изменения и сохраните таблицу Excel в том же месте ( obi.xlsx ). Наконец, выполните следующую команду, чтобы обновить версии шаблонов TSV:

 make update-tsv

Это преобразует вкладки в obi.xlsx обратно в TSV и перезапишет существующие TSV в каталоге src/ontology/templates/ с вашими изменениями. Просмотрите свои изменения ( git diff ) и отправьте запрос на включение.

Поиск терминов

Чтобы узнать, где находится термин, вы можете использовать src/scripts/locate.py .

Затем вы можете запустить скрипт для поиска терминов по идентификатору или метке, передав их в виде списка, разделенного пробелами, например:

 src/scripts/locate.py OBI:0000070 CHMO:0000087 GO:0000785

Метки должны быть заключены в двойные кавычки:

 src/scripts/locate.py "assay" "fluorescence microscopy" "chromatin"

Редактирование служебных сценариев

Репозиторий OBI включает в себя несколько скриптов Python, которые помогут разработчикам эффективно редактировать шаблоны obi-edit.owl и OBI. Для этих сценариев требуется Python 3.

Сценарии также требуют, чтобы вы сначала создали две базы данных (одну из редактирования OBI и одну из объединенной версии OBI):

 make obi-dbs

Изменение маркировки терминов

Поскольку в шаблонах используются метки, поиск и замена всех использований термина вручную может оказаться трудным и утомительным занятием. Вместо этого вы можете использовать src/scripts/relabel.py для автоматического обновления метки термина и его использования.

Вы можете запустить это, передав термин, который хотите обновить, и новую метку:

 src/scripts/relabel.py CHMO:0000087 "microscopy with fluorescence"

Вы также можете передать старую метку в качестве первого аргумента, если она заключена в двойные кавычки:

 src/scripts/relabel.py "fluorescence microscopy" "microscopy with fluorescence"

Обязательно зафиксируйте все измененные файлы, чтобы обеспечить обновление всех использований.

Файлы

• README.md этот обзорный документ
• obi.owl последний выпуск ОБИ
• Скрипты Makefile для построения OBI
• views/ различные специализированные просмотры ОБИ
  • obi.obo последняя версия OBI в формате файла .obo
  • obi_core.owl последняя версия OBI Core: ~100 ключевых терминов
• src/
  • ontology/ исходные файлы для OBI
    • obi-edit.owl основной файл OBI OWL
    • core.txt список основных терминов OBI
    • external-byhand.owl некоторые пользовательские импорты из других онтологий
    • catalog-v001.xml художественный список переопределений импорта OWL.
    • templates/ файлы шаблонов РОБОТОВ для различных филиалов ОБИ
    • modules/ результаты шаблонов РОБОТОВ
    • OntoFox_inputs/ Конфигурационные файлы OntoFox для импорта из других онтологий
    • OntoFox_outputs/ Файлы результатов OntoFox
  • Запросы sparql/ SPARQL для построения и проверки OBI
  • scripts/ служебные скрипты
  • views/ конфигурация для представлений

Здание

Makefile содержит сценарии для создания OBI. В macOS или Linux вы сможете просто запустить make или одну из конкретных задач, указанных ниже. В Windows рассмотрите возможность использования какой-либо виртуальной машины Linux, например Docker или Vagrant. Большинство результатов будет находиться в каталоге build/ . Если у вас возникнут проблемы, свяжитесь с Джеймсом.

• make test и запустить тесты SPARQL (это запускается при каждом отправке на GitHub)
• make sort шаблоны сортировки и исправить кавычки и окончания строк.
• make imports обновить импорт OntoFox
• make modules обновлять шаблоны РОБОТОВ
• make obi.owl построить файл выпуска; рассуждения могут занять около 10 минут
• make views обновлять шаблоны РОБОТОВ
• make all подготовиться к выпуску, запустить imports , modules , test , obi.owl и views
• make build/obi_merged.owl объединить obi-edit.owl в один файл, не рассуждай
• make clean удалить временные файлы

Разработка

Для разработки OBI мы используем git и GitHub. По обоим есть много хорошей документации:

• сайт git с файлами и документацией
• Справка и порядок действий GitHub

Начальная настройка

Прежде чем вы сможете начать разработку с помощью OBI, вам необходимо выполнить некоторые первоначальные настройки:

1. зарегистрируйте учетную запись GitHub

2. установите инструмент командной строки Git, приложение GitHub Desktop или другой клиент Git по вашему выбору.

3. настройте Git, указав свое имя и адрес электронной почты

4. клонировать репозиторий OBI

5. если вы используете macOS и Excel, настройте перехватчик предварительной фиксации (подробности см. ниже):

    ln -s ../../src/scripts/check-line-endings.sh .git/hooks/pre-commit
   

Внесение изменений

Изменения следует вносить по частям, например, добавлять один термин или редактировать несколько связанных терминов. Большинство изменений должно соответствовать одной проблеме на трекере.

Начните с локальной копии master ветки репозитория OBI. Убедитесь, что ваша локальная копия обновлена. Внесите изменения в новую ветку. Для управления новыми идентификаторами используйте таблицу резервирования временных идентификаторов OBI.

Когда вы будете готовы, отправьте свою ветку в репозиторий OBI и сделайте запрос на включение (PR) на веб-сайте GitHub. Ваш пиар — это просьба объединить вашу ветку обратно в master . Ваш пиар будет протестирован, обсужден, при необходимости скорректирован, а затем объединен. Затем цикл может повториться для следующего изменения, которое внесет вы или другой разработчик.

Это шаги с их командами CLI. При использовании приложения с графическим интерфейсом действия будут такими же.

1. git fetch убедитесь, что ваша локальная копия обновлена
2. git checkout master запускается в master ветке
3. git checkout -b your-branch-name создайте новую ветку, названную в соответствии с вносимым вами изменением
4. внесите свои изменения
5. make sort и нормализовать таблицы для более чистых различий
6. git status и git diff проверяют ваши изменения
7. git add --update src/ добавить все обновленные файлы в каталоге src/ в промежуточную версию
8. git commit --message "Description, issue #123" зафиксировать промежуточные изменения с сообщением; хорошо бы указать номер проблемы
9. git push --set-upstream origin your-branch-name отправить ваш коммит на GitHub
10. откройте https://github.com/obi-ontology/obi в своем браузере и нажмите кнопку «Сделать запрос на включение»

Ваш запрос на включение будет автоматически протестирован. Если возникнут проблемы, мы обновим вашу ветку. После прохождения всех тестов ваш PR будет рассмотрен разработчиками ОБИ. Когда эта проверка будет завершена, старший разработчик OBI объединит PR. Промойте и повторите!

Поддержание порядка

Самый простой способ редактировать файлы src/ontology/template/ — использовать Excel. К сожалению, в Excel есть некоторые особые правила цитирования значений ячеек, а в macOS используются старые окончания строк. Обе эти вещи делают наши различия запутанными и запутанными.

Для чистых различий мы также предпочитаем не использовать шаблоны, отсортированные по идентификатору. Команда make sort исправит окончания строк и сортировку, запустив все шаблоны с помощью скрипта Python.