论文复现时如何与原文作者沟通？
2024-08-22
郭思媛
2400

连享会   主页 || 推文 || 知乎 || B 站 || 在线课堂

New！ 搜推文，找资料，用 lianxh 命令：
安装： ssc install lianxh, replace
使用： lianxh 合成控制
       lianxh DID + 多期, w

作者：郭思媛 (中南财经政法大学)
邮箱：siyuanguo2020@163.com

 

编者按：本文参考自下文，特此致谢！
Source：Guidance for Constructive Communication Between Reproducers and Original Authors. -Link-

 

0. 写在前面

ACRe 项目由伯克利社会科学透明度倡议 (BITSS) 和美国经济学会 (AEA) 期刊的数据编辑 Lars Vilhuber 博士共同主导。这一项目的重要成果包括《加速计算可复制性指南》和社会科学复制平台 (SSRP)。该指南旨在通过统一的术语和标准，提升社会科学研究的可复制性，适用于经济学及其他社会科学领域。社会科学复制平台 (SSRP) 的重点在于评估、促进和提升研究的透明度与严谨性。

本推文翻译自《加速计算可复制性指南》第 8 章，主题为“复现者与原作者之间的建设性沟通指导”。该章节提供了复现者如何与原始研究作者进行有效沟通的具体建议，以确保复现过程的透明度和效率。如需获取更多内容和详细指导，请访问 ACRe项目。

 

1. 复现者与原作者之间建设性沟通指导

本章为复现者与原始作者之间的建设性沟通提供了指导。在沟通过程中，使用攻击性或对立性的语言可能会损害专业关系，并阻碍科学进展。Janz 和 Freese (2019) 提出了两个重要步骤，复现者可以采取这些步骤来确保与原作者的互动是建设性的。在此基础上，我们进行了总结，并鼓励您遵循这些指导原则。

记住复现 (和重现) 的黄金规则：对待他人和他们的工作，就像您希望别人对待您和您的作品一样。

仔细且透明地规划您的学习过程：

  • 明确说明您正在复制他们的原创作品。
  • 解释您选择这项研究的原因。
  • 如果无法复现结果，说明结果与原作有多大的偏差，才能声明无法复现。深入研究相关文献，确保您对原作和复现之间差异的解释是全面，且可以被该领域的其他作者接受。

使用专业且敏感的语言：

  • 讨论您的工作与原论文之间的潜在差异，就像您对待自己的工作一样。
  • 避免使用“复现失败”这样的二元判断。相反，应明确指出哪些结果被复现了，哪些没有 (例如，“我们成功复现了 X，但未能复现 Y”)，除非您发现明显的科学不端行为，例如 Broockman 等 (2015)。
  • 讨论研究而非作者，以避免个人化攻击。明确原始文章的积极贡献。考虑向原作者发送您的复现报告副本。
  • 讨论您的复现对文献的贡献，并避免声称给出了问题的最终答案。
  • 对于发表五年或更久的论文，要注意可复现性的标准可能已经发生变化。

请记住，目标不是批评先前的工作或寻找错误，而是推动文献向前发展！

为了帮助您将这些建议付诸实践，我们开发了一些针对复现者和原作者在常见情境中可能遇到的交流模板。我们希望您觉得这些模板有用，但请注意，这些仅为建议，您可以根据项目的具体情况进行调整。

 

2. 与原始研究的作者联系

在联系原始作者之前，请考虑以下事项：

第一步：在 SSRP 上搜索复现材料或与特定论文作者的过去互动记录。对于每次复现，查阅“作者查询”栏目，了解作者是否表明他们愿意接受进一步查询。

第二步：仔细阅读所有脚注、附录、表格、标题等，了解复现材料是如何、在哪里提供的。遵循这些 数据和代码指南 来确定您开始前是否拥有所有必需的东西。需要考虑的几件事包括：

  • 如果可用，Readme 文件是一个好的起点。
  • 检查是否有获取数据或代码的限制，以及是否有关于如何为复现目的访问这些文件的指示。

第三步：如果复现包在文章发布的位置 (例如，期刊网站) 不容易获得，检查作者的网站、Dataverse 档案或其他相关档案库和/或数据存储库，如 ICPSR相关出版物档案。

第四步：如果第 1 步和第 2 步没有结果，联系相应的作者 (如有，抄送合作者)，尽可能将您的请求合并，精简邮件数量。在您的邮件中，确保包括以下细节：

  • 要复现的论文的基本信息 (包括标题、版本、日期和 DOI (或仅 URL))。
  • 复现的上下文 (作为课程练习、论文、个人项目等的一部分)，并注明结果将记录在 SSRP 平台上。
  • 缺失的复现包项目，以及您已经 (未成功地) 搜索过它们的位置。
  • 您的使用计划：这些材料是否将专门用于此项目？请求允许公开共享数据。
  • 咨询权和结果：您是否会与原始作者分享复现的结果？
  • 回复的截止日期 (我们建议至少两周)。

如果您在两周内 (或您设定的任何截止日期) 没有得到回应，进行后续跟进，并包括您第一封邮件中遗漏的任何细节或澄清。同时，在 SSRP 上的选择论文阶段记录您与原始作者互动的结果。您可以将结果归类为以下几种：

  • 提供了完整的复现包。
  • 提供了不完整的复现包。您还可以选择以下原因之一：
    • 数据具有敏感性、机密性或专有性，不能共享；
    • 数据具有敏感性、机密性或专有性，但提供了访问指令。
  • 作者拒绝分享复现包。
  • 作者在最初请求后的四周内没有回应 (包括发送提醒后)。

2.1 当没有复现包时联系原始作者

主题：《[论文标题]》的复现包

亲爱的 [对应作者姓氏] 博士，

我联系您是为了请求您在[年份]于[期刊]发表的论文《[标题]》(卷[卷号]，号[期号])，[链接]的复现包。复现包包含 (原始和/或分析) 数据、代码和其他文档，使得复现论文成为可能。您能分享这些项目中的任何一个吗？

我是[机构]的[研究生/博士后/其他职位]，我希望使用上述复现材料复现结果、表格和其他图表。我选择这篇论文是因为[添加为什么想复现这篇特定论文的背景，使用中立语言 (例如，“这是我领域的一篇开创性论文”)，避免任何可能让被回复者产生防御心理的表述]。不幸的是，我无法在期刊网站、Dataverse (或其他数据和代码存储库) 或您的网站上找到这些材料。

我将在社会科学复现平台 (SSRP) 上记录我的复现尝试结果，这是一个用于系统地进行和记录复现的开源平台。经您允许，我也将记录您与我分享的材料，这将允许其他复现者访问，并避免针对您的重复请求。请告知是否有任何法律或伦理限制适用于任何复现材料，以便我在此练习中考虑到这一点。

此外，您是否愿意响应我或其他 SSRP 用户未来的 (非重复性) 查询？虽然您对我的及/或未来请求的合作将非常有帮助，但您不是必须回应这一点。

由于我需要在[日期]前完成此项目，我将感激您能在[截止日期]前回复。

如果您有任何问题，请告知。也请随时联系我的导师/教师[姓名 (电子邮件) ]获取此练习的更多细节。提前感谢您的帮助！

此致，
[复现者]

2.2 如果作者仅提供附录

如果原作者要求您使用附录复现结果，您没有义务进行这项工作。如果您选择这样做，可以发送以下跟进电子邮件：

亲爱的[对应作者姓氏]博士，

感谢您的回复。我的复现目的是使用原始数据和代码评估和改进计算可复现性。您的附录非常有帮助，我已尝试使用它来复现您的结果。[描述初步复现努力]。

为了帮助我推进复现，我希望您能分享源代码，并就以下内容提供指导：[列出任何不清楚的步骤、数据来源或其他缺失组件。如果超过两项，请使用项目符号]。

提前感谢您的帮助！一旦完成，我将使复现包公开可用，以供未来 SSRP 的复现使用。如果您有任何问题，请告知。

此致，
[复现者]

2.3 联系原始作者请求复现包中缺失的具体项目

主题：《[论文标题]》的复现材料

亲爱的[称呼] [对方姓氏]，

我正在联系您，关于您在[年份]于[期刊]上发表的题为《[标题]》的论文的复现材料。我是[机构]的[研究生/博士后/其他职位]，我正在将这篇论文的复现作为课程作业的一部分。[添加为什么想复现这篇特定论文的背景，使用中性语言 (例如，“这是我领域的一篇重要论文”)，避免任何可能使答复者产生防御心理的表述]。

为了能完整复现这篇论文，我希望您能分享以下项目：[列出复现包中缺失的项目，如果不止一个，请使用项目符号列出 (例如，原始/分析数据、代码、实验操作协议等) ]。我已经在[列出您搜寻过的位置，附上链接]查找过这些项目，但未能找到。除非您另有指示，否则我将使复现包在未来的复现中公开可用。请告知是否有任何法律或伦理限制适用于任何复现材料，以便我在此次活动中加以考虑。

请注意，我将在社会科学复现平台 (SSRP) 上记录我的复现结果，这是一个用于系统地进行和记录复现的开源平台。请告知您是否希望我与您分享我的复现结果，以及您是否有兴趣提供反馈。

由于我需要在[日期]之前完成此项目，我将感激您能在[截止日期]之前回复。

如果您有任何问题，请告知。也请随时联系我的导师/教师[姓名 (电子邮件) ]了解此次练习的更多细节。提前感谢您的帮助！

此致，
[复现者]

2.4 当部分材料已共享时请求额外指导

注意：即使作者已共享复现包，您仍可能会遇到解释或执行材料的挑战。这并不妨碍您向作者请求澄清或索取缺失的材料。如前所述，在类似情况下，请展示您已经善用可用资源，诚实地尝试复现工作，并尽量将您的请求合并到较少的电子邮件中。

主题：《[论文标题]》复现材料的澄清

亲爱的[称呼] [对方姓氏]，

感谢您分享的材料，它们非常有帮助。

不幸的是，当我深入复现时遇到了一些问题，我认为您的指导将有助于解决这些问题。[描述问题以及您尝试解决问题的方式。描述缺失的文件或数据或代码的部分。更多细节请参考下面的示例1和2]。

提前感谢您的帮助。

此致，
[复现者]

示例1：问题描述得很好的例子

具体来说，我正尝试复现显示项X (例如，表1，图3) 。我发现复现显示项X需要以下组件：

   显示项X
       └───[代码] formatting_table1.R
           ├───display_itemx_part1.txt  
           |   └───[代码] output_table1.do           
           |       └───[数据] analysis_data01.csv
           |          └───[代码] data_cleaning01.R*
           |             └───[数据] UNKNOWN
           └───display_itemx_part2.txt  
               └───[代码] output_table2.do           
                   └───[数据] analysis_data02.csv
                      └───[代码] data_cleaning02.R
                         └───[数据] admin_01raw.csv*

我已用星号标记我在复现材料中找不到的项目：data_cleaning01.R 和 admin_01raw.csv。获取这些文件后，我还将确定获取 output1_part1.txt 所需的原始数据集的名称。这是为了告知您，如果我在复现材料中找不到这个文件 (上面标记为 UNKNOWN)，我可能需要再次联系您。

我理解这个请求将需要您做一些工作；我将在社会科学复现平台上 (SSRP) 发布材料，助于避免将来的重复请求。

示例2：问题描述不清的例子

您的论文无法复现。我现在已经尝试了几个小时，无法运行 DO 文件。您能否分享所有缺失的复现材料？数据和代码共享是开放科学的基本原则，所以我相信您会做正确的事情。

2.5 当原作者由于未公开的原因拒绝分享时的回应

注意：如果相应作者在两封或更多的后续电子邮件后未提交回应，也可以使用此模板。

主题：关于《[论文标题]》复现材料的回复

亲爱的[称呼] [对方姓氏]，

感谢您考虑我的请求。我将尝试使用现有材料复现论文，并将在社会科学复现平台 (SSRP) 相应记录缺失项目。我还将根据 SSRP 的可复现性评级标准发布对论文当前形式的可复现性评估。

如果您有任何问题，请告知。

此致，
[复现者]

2.6 原作者因法律或伦理限制而拒绝分享数据时的回应

主题：关于《[论文标题]》复现材料的回复

亲爱的[称呼] [对方姓氏]，

感谢您的回应并澄清了复现材料的使用条款。

虽然我理解您无法分享原始数据，但可能有其他步骤可以帮助我提高论文的可复现性。这些措施包括：

  • 分享数据的分析版本 (即在最终版本的论文中用于分析的数据集版本)；
  • 提供公共描述，说明其他研究者如何申请访问原始数据或材料，包括成本和过程持续时间的估算。您可以在此找到专有或限制访问数据的数据可用性声明示例；
  • 提供所有不受限制的数据和材料的访问权限。

根据我的评估，您的论文在社会科学复现平台 (SSRP) 的可复现性评级中目前的等级为 [level X]。然而，这个评分可以轻松提高。能够提供分析数据将使您的论文的可复现性提升到 [level Y]。提供如何让其他方访问数据的公共指南将进一步提高其可复现性到 [level Z]。

如果您有兴趣采取我概述的任何步骤，我很乐意提供帮助。

感谢您的帮助！

此致，
[复现者]

2.7 联系原作者分享您的复现结果

注意：报告复现结果可能是过程中最具争议的部分，尤其是当复现者无法完全复现论文或发现与原作有重大偏差时。然而，如果复现能正确识别这些偏差的来源，它可能被视为原作的改进版本。

无论复现练习的结果如何，本章导言中的指导仍然适用：复现他人的工作，就如您希望别人复现您的工作一样，并确保这种态度反映在您讨论您与原作之间的任何差异时。

主题：《[论文标题]》的可复现性评估

亲爱的[称呼] [对方姓氏]，

感谢您在我进行项目期间提供的支持，我努力验证并推进[论文]的可复现性。我现在写信是为了分享我的项目结果，并邀请您提供反馈。

我的复现的每个步骤的结果包括：(i) 评估，(ii) 改进，(iii) 稳健性检验，(iv) 如适用，扩展等。
[在电子邮件正文中包括以下项目：]

期待您的问题、评论和对我的工作的建议。如之前讨论的，我将在社会科学复现平台社会科学复现平台 (SSRP) 上记录我的复现结果及改进。

此致，
[复现者]

2.8 对原作者的敌对回应做出回应

注意：仔细且透明地计划您的研究，使用专业和敏感的语言，是确保交互对您和原作者都有益的最佳方式。然而，尽管您尽了最大努力，不愉快的互动可能仍会发生，这可能包括从轻视的评论到欺凌、歧视和骚扰。在本章的最后找到如何处理欺凌、骚扰或歧视事件的指导。

在轻视的评论情况下，最好的行动方针可能是简单地感谢作者的回应，并继续复现。

主题：关于《[论文标题]》复现材料的回复

亲爱的[称呼] [对方姓氏]，

感谢您的回应。我将使用可用的材料继续复现您的论文，并将在社会科学复现平台社会科学复现平台 (SSRP) 相应记录我的结果。我还将根据 SSRP 的可复现性评级标准发布对论文当前形式的可复现性评估。

如果您有任何问题，请告知我。

此致，
[复现者]

 

3. 针对原作者回应复现者请求的指南

本节为在社会科学复现平台上被复现的作品的作者提供指导。我们提供了一些语句模板，以帮助作者应对与复现者互动时可能遇到的各种情况。虽然每一次作者与复现者之间的互动都是独特的，并可能面临特定的挑战，但本章的指导原则始终适用：“以您希望别人对待您和您的工作的方式来对待他人及其工作！”我们希望这些资源能够促进参与各方之间更高效、更建设性的交流。

3.1 响应之前已解决的重复请求

亲爱的[复现者]，

感谢您对我的工作的兴趣。我之前已经被另一位 SSRP 的复现者就这个问题联系过，并已经提供了回应，我怀疑这可能已经记录在 SSRP 上了。我在下面复现了我原始的回应供您参考。您可以在复现包中的 readme 文件中找到更多指导。

如果 SSRP 上之前没有这些问题的记录，请记录下面的回应[和材料]。这也将帮助避免其他可能对此工作感兴趣的人的重复努力。

祝您项目的其余部分好运，并提前感谢您的合作！

此致，
[作者]

3.2 承认作者不再能够访问某些复现包部分

亲爱的[复现者]，

感谢您仔细审查我的工作。我希望我能提供更多帮助，但不幸的是，由于[简要描述阻止您提供材料的情况]，我不再能访问所请求的材料。

虽然我认识到该学科的当前标准已向计算可复现性方向发展，但请注意这篇论文是在不同的标准下编写的。请随意按原样评估论文，并在可能的地方提出任何改进。

我期待与您合作解决这个问题并提高论文的整体可复现性。

此致，
[作者]

3.3 承认一些材料仍在未来研究中被禁止

亲爱的[复现者]，

感谢您对我的工作的兴趣。您提到的数据/材料/程序当前因为[禁止期]而无法公开获取。

[考虑到复现包的限制，请考虑以下分享复现材料的替代方法：1.分享数据的分析版本 (即在论文最终版本中用于分析的数据集版本)；2.提供其他研究者如何申请访问原始数据或材料的步骤的公开描述，包括成本和过程的时间估算。您可以在此找到专有或限制访问数据的数据可用性声明示例；3.提供所有不受限制的数据和材料的访问权限。]

我希望这些信息对您有所帮助。如果您有任何进一步的问题，请随时与我联系。

此致，
[作者]

3.4 响应不完整/不清楚的请求

亲爱的[复现者]，

感谢您对我的工作的兴趣。我很乐意协助您和其他复现者评估和改进这篇论文的可复现性。

为了帮助我提供更具体的指导，我将感激您能提供对您需要的项目的更具体描述。(您可以在指南的第 6 章找到有用的信息和资源，[根据上下文，您可能需要指引复现者查看不同的情景和/或提供更多信息]。)

如果您有任何进一步的问题，请随时联系我。感谢您的合作。

此致，
[作者]

附《加速计算可复制性指南》第六章链接 -Link-

 

4. 相关推文

Note：产生如下推文列表的 Stata 命令为：
  lianxh 复现, m
安装最新版 lianxh 命令：
  ssc install lianxh, replace

资源共享

尊敬的老师 / 亲爱的同学们：
连享会致力于不断优化和丰富课程内容，以确保每位学员都能获得最有价值的学习体验。为了更精准地满足您的学习需求，我们诚挚地邀请您参与到我们的课程规划中来。
请您在下面的问卷中，分享您 感兴趣的学习主题或您希望深入了解的知识领域 。您的每一条建议都是我们宝贵的资源，将直接影响到我们课程的改进和创新。
我们期待您的反馈，因为您的参与和支持是我们不断前进的动力。感谢您抽出宝贵时间，与我们共同塑造更加精彩的学习旅程！https://www.wjx.cn/vm/YgPfdsJ.aspx# 再次感谢大家宝贵的意见！

关于我们

  • Stata连享会 由中山大学连玉君老师团队创办，定期分享实证分析经验。more……
  • 扫码加入连享会微信群，提问交流更方便

⚡ 最新课程推荐：
 

课程一：结构模型 · 2025 · 现场班

课程二：连享会 · 面板数据因果推断

FAQ：往期课程板书和答疑文档

选题征集，点击 此处 或者扫码填写问卷留下您的宝贵意见，感谢！

NEW！视频课堂：lianxh-class.cn

⚡ 新版 lianxh 命令：使用说明
 . ssc install lianxh, replace
 . lianxh 多期DID

⚡ ihelp：帮助文件 PDF 版
 . ssc install ihelp, replace
 . ihelp xtreg

lianxh_cn_saoma

⭕ 连玉君 · Stata 33 讲 - 免费
  o 点击观看，dofile 下载, --Book--

推荐专题