如何打包论文的可复现材料

查看论文可复现材料清单,并下载一套包含数据、代码、README 和预期结果的完整示例。

语言简体中文

论文可复现材料包括什么?

可复现材料包把重跑论文分析所需的文件和说明放在一起。通常需要 README、数据或访问方式、数据字典、分析代码、实际测试的软件和数据版本,以及供核对的预期结果。

下载学习时长研究复现包(ZIP)。解压后打开 README.zh.md,在 study-sessions/ 目录下运行 python analysis/analyze.py。拿生成的 results/means.csv 对照 expected/means.csv。

检查哪些文件可以分享

分别核对数据、代码、说明文档和图片的许可及访问规则。输入受限时,写清楚合资格的读者该如何申请。可以用模拟数据给其他人演示流程,记得说明演示和原分析有哪些差别。

分享前检查文件里是否有密钥、受试者标识或私人笔记。分享 Git 仓库时,提交历史也是发布的一部分。

用一份全新的副本试跑

  1. 打开新副本中的 README,只按上面的步骤操作。
  2. 找到或申请输入数据,并确认版本。
  3. 按说明配置环境,运行分析。
  4. 将新输出与预期结果对照,并记下本次版本。

如果方便,请同事也按说明跑一遍。遇到第一处需要自己猜的地方,就记下来补充进去。发布时让读者可以找到你实际检查过的那一版。

做一次五分钟交接

把示例项目或自己的一个小项目交给同事,请他按 README 重建一张结果表,再告诉你在哪一步犹豫了。

论文可复现材料检查清单

  • README 说明要复现哪个结果,以及从哪条命令开始。
  • 读者能找到或申请数据,并理解各字段的含义。
  • 记录了代码提交、软件版本和数据版本。
  • 有预期结果可供对照。
  • 许可证和访问条件容易找到。

用流程图说明怎么交接

如果项目步骤比较多,可以把从原始数据到结果表的过程画出来。打开 Miss Formula 的 AI Diagram Generator,先画四个节点:原始数据、分析脚本、结果表、他人复核。

在 Studio 免费试用 AI Diagram Generator

参考资源

本文参考并改编自 The Turing Way Community 以 CC BY 4.0 发布的章节。Miss Formula 重新组织了教学顺序,补充了讲解,并编写了贯穿示例和练习。