Formatos abiertos para el intercambio de investigaciones.

Utilice esta guía con los estándares de contribución compartidos. Utilice formatos que los colaboradores puedan inspeccionar, intercambiar y reutilizar con herramientas comúnmente disponibles. Comience con los valores predeterminados a continuación y mantenga la fuente nativa cuando una exportación pierda significado científico o capacidad de edición.

Materiales Por defecto práctico
Notas, protocolos y documentación. Rebaja UTF-8; exportar PDF cuando sea útil una copia de lectura fija.
Mesas pequeñas UTF-8 CSV con un diccionario o esquema de datos.
Tablas escritas más grandes Parquet con diccionario y versión lector/biblioteca; Ofrezca un pequeño ejemplo CSV cuando sea útil.
Registros e intercambios estructurados. JSON; JSONL para un registro por línea. Incluya un esquema cuando los campos necesiten validación.
Configuración editada por humanos YAML o JSON, con la versión soportada y un ejemplo.
Referencias BibTeX, RIS o CSL JSON, conservando DOI u otros identificadores estables.
Figuras y diagramas Fuente editable y SVG cuando corresponda; PNG para imágenes rasterizadas y PDF para copias de publicaciones fijas.

CSV por sí solo no conserva los tipos de campos ni explica qué significan los valores. Registre definiciones de columnas, tipos, unidades, códigos de valores faltantes, formatos de fecha y zonas horarias, identificadores y relaciones entre tablas. Conserve los identificadores con ceros a la izquierda como cadenas. Para una tabla sencilla basta un diccionario breve; Metadatos CSV del W3C proporciona una opción legible por máquina. parquet Conserva los campos escritos pero aún necesita descripciones de su significado y origen.

Utilice formatos de dominio cuando preserven la investigación mejor que una tabla general. Los ejemplos incluyen SBML o CellML para modelos biológicos adecuados y FMI para intercambio de modelos admitidos o co-simulation. NetCDF o HDF5 pueden admitir matrices científicas adecuadas y STEP puede admitir el intercambio CAD. Mantenga el modelo nativo, las entradas del solucionador, los sistemas de coordenadas, las unidades, las dependencias y las versiones de formato necesarias para interpretarlo o volver a ejecutarlo. Verifique una exportación de intercambio en la herramienta receptora antes de tratarla como equivalente a su origen.

Conserva la fuente y su historia.#

Conserve fuentes editables además de leer copias o vincúlelas a través de un manifiesto versionado. Registre la versión de origen, el script de transformación o la configuración de exportación, la versión del software y cualquier información perdida. Una hoja de cálculo puede seguir siendo una fuente de trabajo editable. Exporte sus tablas de cambio y conserve las fórmulas y transformaciones necesarias para reproducirlas. Un PDF o una captura de pantalla por sí solos suelen ser insuficientes para datos o modelos reutilizables.

Mantenga fuentes, esquemas, scripts y metadatos pequeños y compartibles en Git. Coloque los artefactos grandes y el material restringido en un almacenamiento externo adecuado. Realice un seguimiento de un manifiesto que se puede compartir que contiene ID de artefactos, versiones, ubicaciones, sumas de verificación cuando corresponda, procedencia, condiciones de acceso e instrucciones de regeneración. Mantenga rutas y metadatos confidenciales en el registro controlado cuando sea necesario.

Un formato abierto no convierte su contenido en datos abiertos. Indique la licencia o los términos de acceso por separado, conserve la atribución y verifique qué se puede compartir. Utilice el proceso de solicitud de recursos cuando el acceso requiere un administrador. Estos valores predeterminados complementan el estándares de contribución; Los proyectos pueden documentar un mejor formato para sus métodos.

Ver código fuente en GitHub