Documentación de Metadatos

Objetivo

Aprender a documentar los metadatos en la herramienta de publicación IPT.

Introducción

Si es la primera vez que va a documentar metadatos utilizando la herramienta de publicación IPT, le recomendamos ver detenidamente el siguiente video:


Sobre la herramienta

El IPT (del inglés Integrated Publishing Toolkit) es un software gratuito y de código abierto que se utiliza para publicar y compartir conjuntos de datos de biodiversidad a través del SiB Colombia, GBIF y OBIS. Este software permite integrar datos y metadatos en un mismo formato de archivo, conocido como Darwin Core Archive (DwC-A). Una de las ventajas de esta herramienta, frente a otros mecanismos de publicación, es que provee una interfaz para documentar fácilmente los metadatos. Además, contempla la documentación de los autores del recurso, promoviendo así el adecuado reconocimiento a quienes publican datos sobre biodiversidad.

La instancia de publicación principal es el IPT SiB. Adicionalmente, los institutos del SINA administran su propio IPT.

Convenciones

  • Los elementos del estándar Darwin Core aparecen en color verde y cursiva. Por ejemplo: measurementUnit.
  • Los archivos a utilizar en los ejercicios se muestran entre comillas angulares, negrita, y tienen una tipografía diferente. Por ejemplo: «archivo_Ejemplo.xls».
  • Las secciones, ventanas y componentes de las herramientas utilizadas se muestran entre comillas inglesas y en negrita. Por ejemplo: “Create Project”.
  • Las opciones de las herramientas que se asocian a instrucciones (dar clic, seleccionar, etc.) aparecen en color amarillo y cursiva. Por ejemplo: New project.
  • Las secuencias de instrucciones y pasos se muestran en color amarillo, cursiva y negrita. Por ejemplo: Paso 1 > Paso 2.
  • Las líneas que se escriben directamente en las herramientas, para programar o realizar algún proceso en específico, aparecen en formato de código, con una tipografía distinta de color negro. Por ejemplo: value.replace(“ sp.”,””).

Enlace
IPT Test: https://ipt.biodiversidad.co/sib-test/

Requerimientos

Credeniales de ingreso al IPT test:

  • Usuario: LaboratoriosCFV2021@gmail.com.
  • Contraseña: FxKVSjOg.

Archivo de trabajo

Esta guía provee un caso de ejemplo para realizar el ejercicio. Sin embargo, se recomienda realizar el laboratorio con base en un informe o artículo de sus propios datos.


Paso 1 - Ingreso al IPT

Ingrese al IPT test con las credenciales que se encuentran en la sección de requerimientos (Fig. 1).

Figura 1. Página principal del IPT e ingreso a la herramienta.

Paso 2 - Gestión de recursos

Una vez que se haya autenticado en el IPT, podrá ver su información de usuario (Fig. 2A) y tendrá acceso a tres menús o pestañas (Fig. 2B):

  • Inicio: menú disponible para todos los usuarios, el cual lista los recursos disponibles y públicos del IPT.
  • Gestión de recursos: menú disponible solo para los usuarios registrados que han iniciado sesión.
  • Acerca de: menú para todos los usuarios, el cual presenta información general del IPT.

El menú activo se mostrará en un color más oscuro (Fig. 2B).

Figura 2. Página principal del IPT disponible para los usuarios que han iniciado sesión. A. Detalle del usuario activo, B. Menús disponiles.

2.1 Explore el menú Gestión de recursos

Selecione el menú Gestión de recursos (Fig. 3). Aparecerá una tabla de resumen con todos los recursos que puede administrar con su usuario (Fig. 3A), la cual se puede filtrar por texto (Fig. 3B) y reorganizar de forma ascendente o desendente según los contenidos de cada columna (Fig. 3C). Para ingresar a los recursos bajo su administración, haga clic sobre el nombre del recurso en la tabla (Fig. 3). Por último, explore las opciones de la tabla mencionadas anteriormente.

Figura 3. Menú de Gestión de recursos. A. Tabla de recursos adminsitrados, B. Filtro para búsqueda por texto de los recursos, C. Filtro de columna para reorganizar la tabla, D. Sección de creación de un recurso.

Paso 3 - Creación de un recurso

Para crear un recurso, diríjase a la sección de creación del recurso al final del menú Gestión de recursos y siga estos pasos:

3.1. Agignación de nombre corto

Asigne un Nombre corto (no use más de 5 palabras) al recurso que va a crear (Fig. 4A). No incluya espacios ni carácteres especiales como tildes (´) o eñes (ñ). Para este ejercicio, cree el Nombre corto con sus iniciales y el acrónimo de su organización. De esa forma, podrá encontrarlo fácilmente.

3.2. Selección del tipo de recurso

En la lista desplegable de la sección “Tipo”, seleccione la opción que corresponda a los datos que se van publicar (Fig. 4B). En este caso, Registros Biológicos. La elección del tipo de datos durante la creación del recurso no es definitiva, ya que puede cambiar este ítem a lo largo de la publicación.

3.3. Opción para importar un archivo DwC-A

Si posee un Darwin Core Archive (DwC-A), puede usar la función Importar desde archivo. Esta opción solo acepta el formato DwC-A, no permite archivos Excel ni de texto plano. Por consiguiente, dicha opción no se debe usar en este ejercicio (Fig. 4C).

3.4. Creación del recurso

Finalmente, dé clic en la opción Crear (Fig. 4).

Figura 4. Sección de creación del recurso. A. Nombre corto, B .Selección del tipo de datos, C. Carga de un DwC-A (opcional).

Después de crear el recurso, el IPT lo dirigirá a la “Vista General”, donde encontrará 6 secciones para la administración del recurso (Fig. 5). Para este laboratorio, solo debe utilizar la sección “Metadatos”, ya que el Equipo Coordinador del SiB Colombia (EC-SiB) se encarga de configurar y administrar las demás secciones durante el proceso de publicación.

Puede conocer más sobre las seciones de la “Vista General” del recurso en la Guía de referencia rápida del IPT - Vista general.

Figura 5. Secciones de la vista general del recurso.

Paso 4 - Documentación de los metadatos

Tip: el grado de incertidumbre de la identificación puede indicarse agregando varios calificativos, como “aff.” y “cf.”, al nombre científico. El calificativo se escribe después del elemento al que corresponde la incertidumbre de identificación (género o especie).

Desde la “Vista General” del recurso, ubique la sección de “Metadatos” y haga clic en Editar (Fig. 5). Será dirigido al formulario de metadatos, que consta de 12 secciones (Fig. 6). A partir del informe del caso de ejemplo o de un informe o artículo propio, revise y documente cada una de las 12 secciones de metadatos.

Al documentar los metadatos, enfóquese en el conjunto de datos que va a publicar y no en el proyecto bajo el que fueron tomados. Por ejemplo, si usted realizó un estudio filogenético y desea publicar los datos de las muestras de tejido que tomó en campo, describa solo las muestras y observaciones asociadas, no el estudio filogenético.

Esta guía comprende una serie de recomendaciones basadas en las preguntas y errores más frecuentes sobre los metadatos. Por lo tanto, solo encontrará explicaciones para algunos campos. Para complementar este laboratorio y tener acceso a un seguimiento paso a paso, se recomienda revisar la Guía de referencia rápida del IPT - Metadatos.

Figura 6. Secciones de los metadatos.

4.1. Metadatos básicos

“Título”

Borre el título por defecto del IPT y asigne un título relevante que describa los datos a publicar (Fig. 7A).

“Organización publicadora”

Seleccione la organización principal que respalda la publicación de los datos (Fig. 7B). Para efectos de este ejercicio, elija la opción Ninguna organización.

Nota: en esta guía se utiliza el IPT de prueba, por lo que no aparecerán las organizaciones registradas, Puede revisar si su organización ya es un socio publicador en esta lista; si no lo es, lo invitamos a registrarla aquí.

Figura 7. Sección metadatos básicos. A. Título, B. Selección de la organización publicadora, C. Selección de la licencia de los datos.

“Licencia de los datos”

Para asegurar que sus datos sean abiertos, estos deben contar de manera explícita con una licencia que permita su reutilización. En este sentido, escoja una de las licencias Creative Commons que regule hasta dónde quiere que lleguen sus datos (Fig. 7C). Puede usar la guía interactiva de acceso abierto para realizar la elección (Fig. 8).

Figura 8. Herramienta interactiva para elegir una licencia, disponible en la guía de acceso abierto del SiB Colombia.

“Descripción”

Describa brevemente los datos que se van a publicar. Este campo es equivalente a un resumen tipo informe o artículo científico. Por consiguiente, debe incorporar de manera sintética la información de las demás secciones de los metadatos, incluyendo el objetivo del proyecto o estudio, la cobertura temporal, geográfica y taxonómica (Fig. 7).

“Creadores del Recurso”

En esta sección debe incluir a todas las personas que aportaron significativamente a la toma, manejo, digitalización, custodia y publicación de los datos (Fig. 9). A partir de esta información, se crea la citación del recurso que quedará visible a través de todos los portales de datos del SiB Colombia, GBIF y OBIS. Por lo tanto, es equivalente a la lista de autores de un libro o artículo científico. Además, puede añadir a tantas personas como sea necesario. Se recomienda documentar la mayor cantidad de información posible de cada autor (Fig. 9).

Tip: los creadores del recurso deben ser personas, no entidades, ya que el EC-SiB se encarga de recopilar las autorías a nivel institucional por medio del campo "Organización".

Figura 9. Creadores del recurso, sección para documentar los autores del recurso.

Puede ver más detalles acerca de esta sección en la Guía de referencia rápida del IPT - Metadatos básicos.

4.2. Cobertura geográfica

En el mapa de esta sección, desactive el recuadro Establecer cobertura global para seleccionar el punto más cercano a la ubicación del los datos en el mapa. Use la cobertura global solo si sus datos cubren un amplio rango de países. Adicionalmente, ajuste los marcadores en el recuadro del mapa para que cubra de forma aproximada la región donde se tomaron los datos (Fig. 10A).

Ingrese la “Descripción” de la cobertura geográfica, de acuerdo al área de estudio del caso de ejemplo. Recuerde documentar solo lo que hace referencia a la ubicación geográfica de los datos (Fig. 10B).

Nota: si está haciendo el ejercicio con sus propios datos y cuenta con coordenadas, puede realizar un filtro en los elementos de latitud y longitud decimales para identificar la latitud y longitud mínima y máxima. De esta manera, el recuadro se ajustará con mayor exactitud a su cobertura geográfica.

Figura 10. Sección cobertura geográfica. A. Selección de cobertura en mapa, B. Descripción.

Puede ver más detalles acerca de esta sección en la Guía de referencia rápida del IPT - Cobertura geográfica.

4.3. Cobertura taxonómica

Agregue una nueva cobertura taxonómica con el botón Añadir nuevo(a) cobertura taxonómica y complete la descripción, teniendo en cuenta la sección “Resultados” del caso de ejemplo.

Tenga en cuenta que la información mínima a documentar es:

  • Descripción textual de las categorias taxonómicas presentes en el conjunto de datos.
  • Número de taxones o registros por categoría taxonómica.

Ejemplo: los [Números de registros] pertenecen a [x] ordenes, [x] familias y [x] géneros. Un [x%] está identificado a nivel de especie, un [x%] género y un [x%] a familia.

Para agregar varios taxones a la cobertura, haga clic en Añadir varios taxa. Luego, pegue ahí la lista de taxones, la cual puede ser de géneros, órdenes o clases que describan la cobertura taxonómica del recurso. No es recomendable que agregue listas de taxa a nivel de especies, así que intente agruparlas según su taxonomía superior.

Para este caso, agregue los nombres de las especies descritas en los “Resultados” del caso de ejemplo (Fig. 11A) y haga clic en Agregar.

Cuando se haya añadido la lista de taxa, recuerde completar la “Categoría” con una de las opciones del desplegable y el nombre común, si está disponible (Fig. 11B).

Nota: si hay varios grupos biológicos cubiertos en su conjunto de datos (como animales, plantas, bacterias, etc.), se recomienda añadir nuevas coberturas taxonómicas para cada grupo.

Figura 11. Sección cobertura taxonómica. A. Añadir varios taxa, B. Documentación de la categoría y nombre común de cada taxa.

Puede ver más detalles acerca de esta sección en la Guía de referencia rápida del IPT - Cobertura taxonómica.

4.4. Cobertura temporal

Generalmente, los proyectos o publicaciones cubren más de una fecha. Por esta razón, se recomienda usar la opción Rango de Fechas en "”Tipo de Cobertura Temporal”. Recuerde documentar el rango de fechas con el formato del estándar ISO 8601 (AAAA-MM-DD) o usando el botón de calendario (Fig. 12).

El rango de fechas documentado en los metadatos debe ser coherente con el rango de fechas presentes en los datos.

Figura 12. Sección cobertura temporal.

Puede ver más detalles acerca de esta sección en la Guía de referencia rápida del IPT - Cobertura temporal.

4.5 Palabras clave

El IPT crea unas palabras clave por defecto con base en el tesauro de GBIF. Es importante que no borre estos tesauros ni los modifique. En cambio, dé clic en Añadir nuevo(a) palabras clave para crear un nuevo campo y agregar palabras clave (Fig. 13).

Si sus palabras clave provienen de un tesauro como este, indique el nombre del tesauro seguido por la URL en el campo “Tesauro/Vocabulario”. Si no esta usando un tesauro para seleccionar las palabras clave, documente el campo “Tesauro/Vocabulario” con n/a (No Aplica).

Figura 13. Sección palabras clave.

Puede ver más detalles acerca de esta sección en la Guía de referencia rápida del IPT - Palabras clave.

4.6. Partes asociadas

Para este ejercicio, y según el caso de ejemplo, la documentación de la sección “Partes Asociadas” no aplica. Sin embargo, lea las siguientes recomendaciones para futuras publicaciones:

En esta sección, se documenta la información de las personas u organizaciones adicionales que se incluyeron en los metadatos básicos. También se pueden documentar por completo nuevamente si se quiere especificar su rol dentro de la publicación.

¡Precaución!

Es indispensable que el elemento "Rol" esté documentado para todas las partes asocidas que se incluyan en esta sección.

Se recomienda que las partes (personas e instituciones) involucradas en la generación de los datos sean reconocidas en los metadatos, idealmente como “Creadores del recurso” en la sección de “Metadatos básicos” (si se consideran autores del recurso) y en “Partes asociadas” (si estuvieron involucradas en la generación del recurso y cumplen alguno de los roles del campo “Rol”).

Puede ver más detalles acerca de esta sección en la Guía de referencia rápida del IPT - Partes asociadas.

4.7. Datos del proyecto

Documente la sección “Datos del proyecto”, teniendo en cuenta la información proporcionada en el caso de ejemplo.

Los campos “Identificador” y “Personas asociadas al proyecto” no están disponibles en el caso de ejemplo. Sin embargo, tenga en cuenta las siguiente recomendaciones para futuras publicaciones:

  • En el campo “Identificador”, se documenta un código único como el número del contrato, la resolución, el convenio o acuerdo firmado entre las partes, entre otros. No documente subtítulos o textos libres en este campo.

  • En el campo “Personas Asociadas al Proyecto”, se documentan las personas involucradas si estas no fueron mencionadas en los metadatos básicos o como partes asocidas. Si ingresa personas en este campo, debe añadir obligatoriamente el campo “Rol”. De lo contrario, se pueden generar inconvenientes al momento de publicar el recurso.

Puede ver más detalles acerca de esta sección en la Guía de referencia rápida del IPT - Datos del proyecto.

4.8. Métodos de muestreo

Documente esta sección de acuerdo al apartado de “Metodología” en el caso de ejemplo.

  • El campo “Área de estudio” puede coincidir con el espacio documentado en la sección “Datos del Proyecto”.

En el campo “Metodología paso a paso”, es conveniente redactar cada paso en un párrafo diferente para que la publicación sea más ordenada. Por consiguiente, haga clic en Añadir nuevo(a) paso metodológico (Fig. 14).

Figura 14. Metodología paso a paso de la sección métodos de muestreo.

Puede ver más detalles acerca de esta sección en la Guía de referencia rápida del IPT - Métodos de muestreo.

4.9 Referencias

En el campo “¿Cómo referenciar este recurso?”, asegurese de que esté activada la opción Generación automática. De esta forma, dicha sección se diligenciará según lo documentado en los apartados de “Creadores del Recurso” y “Proveedores de los Metadatos”, compilados en la sección “Metadatos Básicos” (Fig. 15).

El formato de la referencia utilizado en la generación automática se basa en el formato recomendado (referencia de DataCite) y satisface la Joint Declaration of Data Citation Principle. Este formato incluye un número de versión, el cual es particularmente importante para los conjuntos de datos que se actualizan continuamente.

Nota: si está activada la referencia automática, la citación incluirá el DOI (previamente asignado a la publicación), lo cual facilitará el rastreo del historial de uso del conjunto de datos.

Cuando se genere la citación, asegúrese de que todos los autores involucrados con la publicación estén correctamente referenciados.

Figura 15. Sección Referencias.

Puede ver más detalles acerca de esta sección en la Guía de referencia rápida del IPT - Referencias.

4.10. Datos de la Colección

Documente esta sección con base en la información sobre la colección de la portada e introducción del caso de ejemplo, solo en los siguientes casos:

  1. El conjunto de datos corresponde a una colección biológica.
  2. Una o varias de las observaciones del conjunto de datos está asociada a un especímen que fue entregado y depositado en una colección biológica.

Es recomendable documentar los campos de acuerdo al Registro Nacional de Colecciones Biológicas. Puede añadir tantas coleciones como sea necesario (Fig. 16).

Figura 16. Sección datos de la colección documentados de acuerdo al Registro Nacional de Colecciones Biológicas.

Puede ver más detalles acerca de esta sección en la Guía de referencia rápida del IPT - Datos de la Colección.

4.11 Enlaces Externos

Esta es una sección opcional. Puede incluir la URL de otro repositorio donde también se encuentren los datos publicados. Por ejemplo, DRYAD, NCBI, BOLD, entre otros.

Puede ver más detalles acerca de esta sección en la Guía de referencia rápida del IPT - Enlaces Externos.

4.12 Metadatos Adicionales

Esta es una sección opcional. Generalmente, el publicador no debe documentar ningún campo. El EC-SiB añadirá el logo de la organización publicadora principal (Fig. 17A) y el IPT completará automáticamente los “Identificadores Alternativos”, que incluyen la url del recurso en el IPT, el DOI y el ID del recurso en el SiB Colombia y GBIF, una vez que se publique el recurso (Fig. 17B).

Figura 17. Sección metadatos adicionales. A. Logo estandarizado del publicador, B. identificadores alternativos.

Puede ver más detalles acerca de esta sección en la Guía de referencia rápida del IPT - Metadatos Adicionales.

Paso 5 - Datos propios

Si realizó este laboratorio con el caso de ejemplo, ahora intente crear un nuevo recurso para documentar los metadatos con base en sus propios informes o artículos.


¡Felicitaciones! Ha aprendido a documentar los metadatos asociados a datos sobre biodiversidad a través del IPT.


Atribución y uso de los laboratorios

La licencia CC-BY permite usar, redistribuir y construir sobre estos contenidos libremente.

¡La difusión de estos laboratorios contribuirá a la publicación de más y mejores conjuntos de datos sobre biodiversidad!

Citación sugerida

Plata C., Ortíz R., Marentes E. (2021). Laboratorio de datos, Ciclo de formación. Consultado a través del SiB Colombia. Disponible en https://biodiversidad.co/formacion/laboratorios.