obi

Ontología para Investigaciones Biomédicas

La Ontología para Investigaciones Biomédicas (OBI) le ayuda a comunicar claramente sobre las investigaciones científicas al definir más de 2500 términos para ensayos, dispositivos, objetivos y más.

Este es el repositorio de desarrolladores para OBI. Puede descargar los productos OBI más actualizados aquí y obtener más información sobre OBI a través de nuestra documentación.

Edición

Nuestros términos de ontología se dividen en tres grupos. Dependiendo de qué tipo de término quieras editar o agregar, tendrás que seguir diferentes rutas:

1. Términos externos (de otras ontologías): Usamos OntoFox para las importaciones. Edite el archivo src/ontology/OntoFox_inputs/ correspondiente.

2. Términos de plantilla: utilizamos plantillas ROBOT para convertir hojas de cálculo a OWL. Edite el archivo src/ontology/templates/ relevante:

   • obsolete.tsv para términos obsoletos
   • assays.tsv para ensayos generales
   • epitope-assays.tsv específicamente para ensayos de epítopos inmunes
   • value-specifications.tsv
   • specimens.tsv para especímenes
   • medical-history.tsv para clasificaciones de historial médico y criterios de selección relacionados
   • study-designs.tsv para diseños de estudio.
   • data-sets.tsv para conjuntos de datos

3. otros términos: Edite src/ontology/obi-edit.owl en Protege.

Consulte a continuación una lista completa de archivos, instrucciones de compilación e instrucciones sobre el uso de Git y GitHub para OBI.

Importar desde una nueva ontología

Si desea importar términos de una ontología para la cual OBI no tiene actualmente un archivo de importación de OntoFox ( src/ontology/OntoFox_inputs/ ), siga estos pasos:

1. Escriba el archivo de importación para la nueva ontología (consulte los archivos de importación existentes como referencia).
2. Actualice catalog-v001.xml para enumerar el nuevo archivo de importación como enumera los archivos de importación existentes.
3. Agregue una declaración de importación a obi-edit.owl .
4. Cree un archivo en blanco para el módulo de salida en src/ontology/OntoFox_outputs/ , por ejemplo, para generar una salida falsa para las importaciones de foo.owl:

 touch src/ontology/OntoFox_outputs/foo_imports.owl

5. Construye el módulo y obi.owl.

 make imports
make obi.owl

Edición de plantillas en Excel

Si desea editar una plantilla o plantillas en Excel, en lugar de copiar y pegar la plantilla, le pedimos que siga este flujo de trabajo para conservar las citas. Ir y venir con Excel puede provocar algunos cambios involuntarios en las comillas dobles dentro de las plantillas.

Primero, instale los requisitos de Python:

 python3 -m pip install -r requirements.txt

Luego, haz la hoja de Excel. En su directorio OBI git local, ejecute el siguiente comando para crear un archivo llamado obi.xlsx :

 make obi.xlsx

A continuación, abra obi.xlsx en Excel (o el editor que prefiera). Esta hoja de cálculo contiene una pestaña para cada plantilla de OBI (p. ej., "diseño de estudio", "ensayos", etc.). Busque la pestaña que corresponde a la plantilla que necesita editar, realice los cambios y guarde la hoja de cálculo de Excel en la misma ubicación ( obi.xlsx ). Finalmente, ejecute lo siguiente para actualizar las versiones TSV de las plantillas:

 make update-tsv

Esto convertirá las pestañas en obi.xlsx nuevamente a TSV y sobrescribirá los TSV existentes en el directorio src/ontology/templates/ con sus cambios. Revise sus cambios ( git diff ) y realice su solicitud de extracción.

Encontrar términos

Para saber dónde reside un término, puede utilizar src/scripts/locate.py .

Luego puede ejecutar el script para buscar términos por ID o etiqueta pasándolos como una lista separada por espacios, por ejemplo:

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

Las etiquetas deben estar entre comillas dobles:

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

Edición de scripts de utilidad

El repositorio de OBI incluye algunos scripts de Python para ayudar a los desarrolladores a editar de manera eficiente las plantillas obi-edit.owl y OBI. Estos scripts requieren Python 3.

Los scripts también requieren que primero cree dos bases de datos (una desde la edición de OBI y otra desde una versión fusionada de OBI):

 make obi-dbs

Términos de reetiquetado

Dado que las etiquetas se utilizan en plantillas, encontrar y reemplazar manualmente todos los usos de un término puede resultar difícil y tedioso. En su lugar, puede usar src/scripts/relabel.py para actualizar automáticamente la etiqueta de un término y sus usos.

Puedes ejecutar esto pasando el término que deseas actualizar y la nueva etiqueta:

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

También puede pasar la etiqueta anterior como primer argumento, siempre que esté entre comillas dobles:

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

Asegúrese de confirmar todos los archivos modificados para garantizar que todos los usos estén actualizados.

Archivos

• README.md este documento general
• obi.owl la última versión de OBI
• Scripts Makefile para construir OBI
• views/ varias vistas especializadas de OBI
  • obi.obo la última versión de OBI en formato de archivo .obo
  • obi_core.owl la última versión de OBI Core: ~100 términos clave
• src/
  • ontology/ archivos fuente para OBI
    • obi-edit.owl el archivo principal OBI OWL
    • core.txt la lista de términos principales de OBI
    • external-byhand.owl algunas importaciones personalizadas de otras ontologías
    • catalog-v001.xml una lista artesanal de anulaciones de importación de OWL
    • templates/ archivos de plantilla ROBOT para varias ramas de OBI
    • modules/ los resultados de las plantillas del ROBOT
    • OntoFox_inputs/ Archivos de configuración de OntoFox para importar desde otras ontologías
    • OntoFox_outputs/ Archivos de resultados de OntoFox
  • consultas sparql/ SPARQL para construir y validar OBI
  • scripts/ scripts de utilidad
  • views/ configuración de vistas

Edificio

El Makefile contiene scripts para construir OBI. En macOS o Linux, debería poder ejecutar make o una de las tareas específicas a continuación. En Windows, considere utilizar algún tipo de máquina virtual Linux como Docker o Vagrant. La mayoría de los resultados estarán en el directorio build/ . Si tiene problemas, comuníquese con James.

• fusionar make test y ejecutar pruebas SPARQL (esto se ejecuta cada vez que se envía a GitHub)
• make sort plantillas de clasificación y corregir comillas y finales de línea
• make imports actualizar las importaciones de OntoFox
• make modules actualicen las plantillas de ROBOT
• make obi.owl construya el archivo de lanzamiento; el razonamiento puede tardar unos 10 minutos
• make views actualicen las plantillas de ROBOT
• make all se preparen para un lanzamiento, ejecute imports , modules , test , obi.owl y views
• make build/obi_merged.owl combine obi-edit.owl en un solo archivo, no razone
• make clean eliminar archivos temporales

Desarrollo

Usamos git y GitHub para desarrollar OBI. Hay mucha buena documentación sobre ambos:

• sitio web de git con archivos y documentación
• Ayuda y flujo de GitHub

Configuración inicial

Antes de poder comenzar a desarrollar con OBI, deberá realizar una configuración inicial:

1. registrarse para obtener una cuenta de GitHub

2. instale la herramienta de línea de comandos de Git, la aplicación GitHub Desktop u otro cliente Git de su elección

3. configura Git con tu nombre y correo electrónico

4. clonar el repositorio OBI

5. Si está utilizando macOS y Excel, configure un enlace de confirmación previa (consulte a continuación para obtener más detalles):

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

Hacer cambios

Los cambios deben realizarse en partes manejables, por ejemplo, agregar un término o editar algunos términos relacionados. La mayoría de los cambios deberían corresponder a un único problema en el rastreador.

Comience desde una copia local de la rama master del repositorio OBI. Asegúrese de que su copia local esté actualizada. Realice sus cambios en una nueva rama. Utilice la hoja de Reservas de ID de plazo de OBI para administrar nuevas ID.

Cuando esté listo, envíe su rama al repositorio de OBI y realice una solicitud de extracción (PR) en el sitio web de GitHub. Su PR es una solicitud para fusionar su rama nuevamente con master . Su PR será probado, discutido, ajustado si es necesario y luego fusionado. Luego, el ciclo puede repetirse para el próximo cambio que usted u otro desarrollador realice.

Estos son los pasos con sus comandos CLI. Cuando utilice una aplicación GUI, los pasos serán los mismos.

1. git fetch asegúrese de que su copia local esté actualizada
2. inicio git checkout master en la rama master
3. git checkout -b your-branch-name crea una nueva rama con el nombre del cambio que estás realizando
4. haz tus cambios
5. make sort ordenar y normalizar tablas, para obtener diferencias más limpias
6. git status y git diff inspeccionan sus cambios
7. git add --update src/ agrega todos los archivos actualizados en el directorio src/ al staging
8. git commit --message "Description, issue #123" confirma los cambios preparados con un mensaje; es bueno incluir un número de problema
9. git push --set-upstream origin your-branch-name envía tu compromiso a GitHub
10. abra https://github.com/obi-ontology/obi en su navegador y haga clic en el botón "Hacer solicitud de extracción"

Su Pull Request se probará automáticamente. Si hay problemas, actualizaremos su sucursal. Cuando todas las pruebas hayan pasado, los desarrolladores de OBI revisarán su PR. Cuando se complete esa revisión, un desarrollador senior de OBI fusionará el PR. ¡Enjuague y repita!

Mantener las cosas ordenadas

La forma más sencilla de editar nuestros archivos src/ontology/template/ es con Excel. Desafortunadamente, Excel tiene algunas reglas idiosincrásicas para citar valores de celda y en macOS usa finales de línea antiguos. Ambas cosas hacen que nuestras diferencias sean confusas y confusas.

Para obtener diferencias claras, también nos gusta mantener las plantillas ordenadas por ID. El comando make sort arreglará los finales de línea y la clasificación ejecutando todas las plantillas a través de un script de Python.