研究交流的开放格式

将此指南与共享贡献标准结合使用。使用协作者可以通过常用工具检查、交换和重用的格式。从下面的默认值开始,并在导出失去科学意义或可编辑性时保留本机源。

材质 实际默认
注释、协议和文档 UTF-8 降价;当固定阅读副本有用时导出 PDF。
小桌子 带有数据字典或模式的 UTF-8 CSV。
更大的类型表 Parquet 配有词典和阅读器/图书馆版本;提供一个有用的小型 CSV 示例。
结构化记录和交换 JSON; JSONL 每行一条记录。当字段需要验证时包括架构。
人工编辑的配置 YAML 或 JSON,以及支持的版本和示例。
参考文献 BibTeX、RIS 或 CSL JSON,保留 DOI 或其他稳定标识符。
图表 在适当的情况下可编辑源代码和 SVG; PNG 用于光栅图像,PDF 用于固定出版物副本。

CSV 本身不保留字段类型或解释值的含义。记录列定义、类型、单位、缺失值代码、日期格式和时区、标识符以及表之间的关系。将带有前导零的标识符保留为字符串。对于一个简单的表格来说,一个简短的字典就足够了; W3C CSV 元数据 提供机器可读的选项。 实木复合地板 保留类型化字段,但仍然需要对其含义和起源的描述。

当域格式比一般表格更好地保存研究内容时,请使用域格式。示例包括用于合适生物模型的 SBML 或 CellML 以及用于支持模型交换的 FMI 或 co-simulation。 NetCDF或HDF5可以支持合适的科学阵列,STEP可以支持CAD交换。保留解释或重新运行所需的本机模型、求解器输入、坐标系、单位、依赖项和格式版本。在将其视为等同于其源之前,请检查接收工具中的交换导出。

保留来源及其历史记录#

除了阅读副本之外,还保留可编辑的源代码或通过版本化清单链接它们。记录源版本、转换脚本或导出设置、软件版本以及任何丢失的信息。电子表格可能仍然是可编辑的工作源。导出其交换表并保留重现它们所需的公式和转换。对于可重用数据或模型来说,单独的 PDF 或屏幕截图通常是不够的。

在 Git 中保存小型、可共享的源、模式、脚本和元数据。将大型工件和受限材料放入适当的外部存储中。跟踪可共享清单,其中包含工件 ID、版本、位置、适当的校验和、出处、访问条件和重新生成指令。必要时将机密路径和元数据保存在受控记录中。

开放格式并不使其内容成为开放数据。单独说明许可或访问条款,保留归属,并检查可以共享的内容。使用 资源请求流程 当访问需要管理员时。这些默认值补充了 贡献标准;项目可以为其方法记录更好的格式。

查看 GitHub 上的源代码