RigorMed
← 科研资源

科研方法 · 分析包交接

科研分析复现包怎么交接?从README到重跑验收

交接的不是一个压缩包,而是一条从已授权输入到指定结果的可检查路径。先写明输入版本、执行顺序、环境与输出判据,再让接收者在隔离目录重跑并记录差异。

科研复现与交付

本页面向有权使用的公开或合成研究材料,解决“另一位合作者拿到文件后,如何知道从哪里开始、怎样核对结果”。投稿检查页负责稿件中的数字与证据是否一致;这里负责这些结果能否沿同一材料和代码重新生成。

本文采用The Turing Way的计算复现用法:用同一数据和同一分析步骤重新得到结果。不同学科术语可能不同;用新数据验证、换方法检验稳健性和证明结论可推广,都不是一次重跑可以替代的。

一份最小交接目录,各文件必须有责任

以下名称是教学组织建议,不是必须安装的软件或本站导出格式。按真实项目调整,说明每个输入如何取得、每个输出由哪一步产生。

一份最小交接目录,各文件必须有责任
位置示例应写清什么接收者如何核对
README研究范围、材料权限、入口、步骤顺序、预期输出、停止条件和联系人角色不靠作者口头补充就能知道第一步及限制
inputs/ 与 data-dictionary来源版本或文件ID、相对路径、单位、编码、缺失约定;无再分发许可时仅给合法获取说明实际可取得的输入是否与分析版本一致
scripts/ 与 analysis-plan清洗、分析、表图生成的顺序、参数与纳排规则每个关键结果是否有生产步骤,而非手工抄数
environment操作系统、语言和包的实际版本、安装说明;适用时记录随机种子、线程与硬件限制是否能在声明的环境执行,而非只有“最新版”
expected/ 与 output-map预期文件、表图对应关系、需要一致的字段及事先规定的容差不把文件存在或四舍五入后相似当数值一致
rerun-record实际日期、环境、执行步骤、退出状态、差异与未完成项明确未运行、失败、部分通过与已核对范围

交接前移除密钥、访问令牌、绝对个人路径和不允许公开的行级材料。代码许可、数据使用条件和访问限制分别说明;可下载不等于可再分发。

先建清单,再做一次不借旧结果的重跑

  1. 锁定要复现的结果

    指定本次稿件或分析版本、主要表图及对应方案,不把探索性输出混进正式结果。材料缺失或授权不清时先列缺口,不能从论文反推原始数据。

  2. 把输入、步骤与输出逐项连接

    为每张表或图记录输入位置、产生它的脚本、参数及输出路径。使用相对路径,列清前后依赖;若某步仍需人工选择,写明决定规则和真实记录,不能藏成“自动完成”。

  3. 写出确实可执行的环境与入口

    README列出实际验证过的安装与运行命令、工作目录和顺序。本文不提供未经验证的通用运行命令;原作者应在自己的交接包中填写。随机种子不保证跨软件、线程或硬件逐位相同。

  4. 在新目录运行,不覆盖原件

    保留原始材料和正式输出,把本次生成结果写入独立目录。不让脚本直接复制expected中的旧文件当新结果;网络来源需要固定版本与合法获取路径,不能依赖会变化的私人链接。

  5. 按预定判据比对内容

    先比较样本量、分母、变量、模型和效应单位,再比较估计值、区间、表图数据。文本日期等非科学差异可另列;浮点容差须事先说明,不能看到差异后放宽直到通过。

  6. 记录失败边界,再交给合作者

    保存实际执行与差异记录。缺输入、依赖失败或关键结果不符就停止相关结论,不补零、不手改输出凑一致。文件齐全但未运行只能写“待重跑”;一次成功不等于跨环境或研究质量认证。

合成教学片段:验收目标要比“成功生成CSV”更具体

自写教学输入只有一列x,共5行:1、2、3、4和一个空白。预定规则仅对这个算术例求非空值均值,不做插补;应检查总行数5、有效值4、缺失1、均值2.5。它不是患者资料、真实研究结果、统计分析建议或产品实跑。

输出映射可以写为:summary.csv的n_total/n_valid/n_missing/mean_x,对应README的检查项;重跑日志另记实际命令、环境和是否比对。只生成一份写着2.5的文件并不能证明计算实际执行。

若收到均值2.0,应先核查是否把空白填0;若有效值变5,应追查解析或预处理规则。不要先改期望值。这说明交接包要公开规则和分母,而不只是交付一个看起来相同的表格。

让AI先整理交接缺口,不让它替你宣布复现成功

建议提供:你有权使用的文件目录、公开或合成数据字典、现有README、已确认的运行说明和脱敏执行摘要。不要为了整理清单上传患者行、凭据或无权分享的全文。

可改写的输入:仅根据所给材料,按“目标结果—输入版本/位置—执行步骤/参数—输出—验收字段—缺口”整理交接表及README草稿。找不到命令、版本或实际执行证据时写待确认,不编造环境、结果或已通过记录。

可请求的产物是交接表、README草稿与待确认项;这只是建议任务与交付规格,不是本轮真实执行或客户成效。是否能运行具体代码,应另核材料、能力、权限与执行前确认。

交付时应能回答的五个问题

交付时应能回答的五个问题

  • 接收者能合法取得相同版本的输入,且字典与参数明确吗?
  • 每个关键输出都能找到生成步骤,而非作者本机上的手工文件吗?
  • 环境、命令与顺序来自实际验证,未验证部分清楚标了吗?
  • 比对了内容、分母、单位和预定容差,而非只看退出0或文件存在吗?
  • 失败、未运行、人工步骤与不能公开的部分如实记录了吗?

复现路径清楚仍不能证明研究设计、偏倚控制、数据授权或因果结论正确。PLOS的材料与代码政策是该出版体系的具体要求,不自动等同于所有期刊规则;限制分享时须按适用政策说明原因与合法访问办法,不公开敏感数据。

核验来源

以下官方来源核验于 2026-10-21,页面发布前将再次检查访问条件和更新时间。

  1. The Turing Way:复现术语与定义

    同数据、同分析路径的计算复现及其与新数据验证的区别;术语并非跨学科统一。

  2. PLOS:材料、软件与代码共享政策

    代码、运行文档、依赖及测试材料与共享限制;具体适用范围以当前政策为准。

科研复现与交付

把现有材料整理成可审阅的交接说明

在RigorMed工作台说明你的材料权限、已有文件与希望核查的交接问题,可采用上面的输入。先确认可处理范围与实际交付,再由研究者核对来源、执行记录和差异;不把整理清单当成已完成重跑。