mcpField
R
reproducibility-statement

reproducibility-statement

github.com/kalarislabs文档处理7359 次安装3 天前更新
代码仓库

关于 reproducibility-statement

面向学术作者的研究技能,指导撰写可核验的数据、代码及其他透明度声明,并按投稿时要求检查清单。

主要功能

  1. 01按投稿场所梳理声明要求
  2. 02撰写数据与代码可用性声明
  3. 03核验链接和持久标识符
  4. 04检查代码发布与复现材料
  5. 05规范伦理、经费及 AI 使用披露

适用场景

  1. 01准备期刊或会议投稿声明
  2. 02核实数据与代码的访问条件
  3. 03整理机器学习论文的计算报告

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/kalarislabs/research-agent-skills --skill reproducibility-statement

安装后在 Claude Code 中输入/reproducibility-statement确认已加载。

详细介绍

可复现性与透明度声明

工作流程

  1. 列出投稿场所要求的所有声明和清单(第 1 节)。
  2. 存档数据和代码,并在撰写声明前获取持久标识符。
  3. 撰写每项声明时,明确具体位置、许可证和访问条件。
  4. 退出登录后验证每个链接和存档号。切勿声称尚未实现的可用性。
  5. 如实填写清单,并为每个“否”提供理由。

编辑越来越常因声明缺失或含糊而直接拒稿,审稿人也会核查这些声明。应将每项声明都视为准确、可验证的陈述,而非套话。

1. 确认投稿场所的要求

查看目标投稿场所最新的作者指南和清单(venue-templates 和 journal-format 技能会指向相关内容)。常见要求包括:

投稿场所类型典型要求
ML 会议(NeurIPS、ICML、ICLR)PDF 中包含论文清单(可复现性、计算资源、许可证、更广泛影响、LLM 使用情况),鼓励提供代码
ACL / ARR 投稿场所负责任 NLP 清单、局限性章节(必需)、伦理声明
Nature Portfolio数据和代码可用性声明、报告摘要、图表的源数据
PLOS必须提供数据可用性声明;除非法律上豁免,否则数据必须不受限制地提供
临床期刊试验注册、数据共享声明(ICMJE)、报告指南清单(CONSORT、STROBE 等)
Cell PressSTAR Methods,包含关键资源表和资源可用性章节

2. 数据可用性声明

说明数据位于何处、如何获取以及适用哪些条件,并提供持久标识符:

支持本研究结论的处理后数据可在 Zenodo (https://doi.org/10.5281/zenodo.XXXXXXX) 获取, 采用 CC BY 4.0 许可。原始测序读段已存入 SRA,所属 BioProject 为 PRJNAXXXXXX。由于[法规], 患者级临床数据无法公开共享。可联系[数据访问委员会联系人]提出申请,获取数据需签署数据使用协议。

  • 有领域专用存储库时应优先使用(GEO/SRA/ENA、PDB、PRIDE、OpenNeuro、Dryad、ICPSR、 PANGAEA)。否则使用通用存储库(Zenodo、Figshare、OSF、Dataverse)。
  • 仅写“可在合理请求后提供”越来越容易被拒。请说明限制原因和获取途径。
  • 在投稿前预留 DOI(Zenodo 支持预留 DOI)。如果投稿场所允许,请使用供审稿人访问的私有链接。

3. 代码可用性与制品打包

发布的存储库检查清单:

  • 标记与论文版本一致的发布版本,并存档到 Zenodo(GitHub 集成会生成 DOI)
  • 提供 README,包含安装说明、最简示例,以及用于复现每张表格/每幅图的准确命令
  • 固定环境:uv.lock/requirements.txt(含版本)、environment.yml 或容器镜像摘要
  • 记录随机种子、运行次数和硬件,并报告方差(N 个随机种子的均值 ± 标准差)
  • 提供数据下载/预处理脚本(切勿分发未获再分发许可的数据)
  • 如果预训练权重或检查点是核心论据,则提供校验和
  • 提供 LICENSE(代码使用 OSI 批准的许可证;文本/数据使用 CC BY),并遵守第三方许可证
  • 提供 CITATION.cff,让 GitHub 显示“引用此存储库”
  • 双盲评审期间匿名处理(使用匿名 GitHub 镜像),终稿阶段恢复真实身份

4. 计算资源与环境报告(ML 和模拟)

报告硬件信息(GPU/CPU 类型和数量)、主要实验以及整个项目的总计算量(GPU 小时),包括超参数搜索。报告关键框架的软件版本。

5. 其他声明

  • 作者贡献(CRediT):将每位作者对应到 14 项角色(概念构思、方法设计、软件、验证、正式分析、调查、资源、数据管理、撰写——初稿、撰写——审阅与编辑、可视化、监督、项目管理、经费获取)。
  • 利益冲突:声明财务和非财务利益,或说明“无”。
  • 经费:基金方名称和资助编号须严格遵循基金方的要求。
  • 伦理:IRB/伦理委员会名称和批准编号、知情同意流程、动物福利审批、双重用途考量。
  • AI 工具的使用:遵循投稿平台的政策。大多数平台要求披露在写作或分析中使用生成式 AI,并禁止将 AI 列为作者。说明使用了什么工具,以及如何核验其输出。
  • 局限性/更广泛的影响:具体失效模式、结果可能不适用的人群或情境、潜在滥用方式及缓解措施。

规则

  • 每项声明在投稿时都必须属实。核验每个链接和访问编号均可正常使用(退出登录后,在无痕窗口中检查)。
  • 除非有作者以外的人按照 README 重新运行过,否则不要声称“完全可复现”。
  • 诚实填写检查清单。“否”并附上理由,胜过没有依据的“是”。

相关技能

ml-paper-writing、scientific-writing、venue-templates、datalad、lamindb、research-grants(数据管理计划)。

评论

支持 Markdown