可重复研究:如何让你的研究明了易懂?

发布时间:2021-12-26 阅读 609

Stata连享会   主页 || 视频 || 推文 || 知乎 || Bilibili 站

温馨提示: 定期 清理浏览器缓存,可以获得最佳浏览体验。

New! lianxh 命令发布了:
随时搜索推文、Stata 资源。安装:
. ssc install lianxh
详情参见帮助文件 (有惊喜):
. help lianxh
连享会新命令:cnssc, ihelp, rdbalance, gitee, installpkg

课程详情 https://gitee.com/lianxh/Course

课程主页 https://gitee.com/lianxh/Course

⛳ Stata 系列推文:

PDF下载 - 推文合集


作者: 伊凌雪 (中央财经大学)
邮箱: yilingxue99@163.com


目录


Source: Uri Simonsohn, 2018, Blog - Eight things I do to make my open research more findable and understandable. -Link-

1. 引言

研究人员在发表研究之后发布原始文件、数据或者代码是很常见的,这显然很好,但是公开的研究通常很难找到和理解。

在这篇文章中,作者Uri Simonsohn 给出了在文章、代码和数据文件中所做的 8 件事来解决这个问题。

2. 具体做法

2.1 文章

1)在介绍方法之前,包含一段陈述关于公开研究实践的段落,如下所示:

2)在论文结束之前,添加补充表格的目录。 文本内容类似于“线上的补充材料是可以获得的,表 1 总结了其内容”。

3)在表格和图标题中,加入可以复制它们代码的链接。

2.2 代码

4)提供的代码中表明作者身份、最后更新时间以及联系信息。 5)提供代码的大纲。

如下图所示:

然后,代码中使用相同的大纲标题,以便读者可以轻松浏览代码 。

6)经验法则:每 3 行代码至少有一条注释。

即使有些内容比较直观易懂,通过注释也会提高阅读代码的效率。但是大多数事情没有那么简单弄清楚。此外,没有人能像你编写代码时那样理解你的代码,包括 72 小时后的你自己。并且在代码中编写注释时,要清楚谁可能阅读它是真正有用的。

2.3 数据

7)codebook (非常重要) 。最好有一个简单的独立文本文件,如下图所示,变量名后跟着描述,其中包括可能的取值和相关集合的详细信息。

8)发布允许的最原始形式的数据。 然后在发布的代码中完成所有的数据清洗工作,当清洗的范围很广时,同时发布原始文件和清洗过的数据文件。

3. 总结

总结来看,根据作者在文章、代码和数据方面的做法,主要概括为以下8个要点:

  1. 文章:公开研究声明

  2. 文章:添加表格目录

  3. 在图标题中:添加可重现代码的链接

  4. 在代码中:作者联系信息和描述

  5. 在代码中:后续程序的大纲和提要

  6. 在代码中:每 3 行至少一条注释

  7. 数据:放入 codebook(文本文件,变量名,描述)

  8. 数据:发布最原始版本的数据

4. 示例论文

一些学者的公开研究中也包含了前文所提到的 8 个要点,作者往往会在说明文件中对文章的数据和代码以及软件使用情况进行简要介绍,可以帮助读者更清晰地了解研究过程以及进行研究结果重现。本文列出以下几篇范文示例作为参考,更多的范文详见: 连享会:论文重现网站大全

  • Bruno Merlevede and Angelos Theodorakopoulos, "Productivity Effects of Internationalisation through the Domestic Supply Chain", Journal of Applied Econometrics, Vol. 36, No. 6, 2021, pp. 808-832. -Replication-

  • Hector M. Nunez and Jesus Otero, "A One Covariate at a Time, Multiple Testing Approach to Variable Selection in High-Dimensional Linear Regression Models: A Replication in a Narrow Sense", Journal of Applied Econometrics, Vol. 36, No. 6, 2021, pp 833-841. -Replication-

  • James D. Hamilton, "Measuring Global Economic Activity," Journal of Applied Econometrics, Vol. 36, No. 3, 2021, pp. 293-303. -Link-

  • Acemoglu, K. Daron, and Pascual Restrepo. 2019. “Automation and New Tasks: How Technology Displaces and Reinstates Labor.” Journal of Economic Perspectives 33 (2): 3–30. -PDF1-, -PDF2-, -Cited by-, -Replication-

5. 参考资料

1、Eight things I do to make my open research more findable and understandable

2、Stata命令详解-codebook

6. 相关推文

相关课程

免费公开课

最新课程-直播课

专题 嘉宾 直播/回看视频
最新专题 文本分析、机器学习、效率专题、生存分析等
研究设计 连玉君 我的特斯拉-实证研究设计-幻灯片-
面板模型 连玉君 动态面板模型-幻灯片-
面板模型 连玉君 直击面板数据模型 [免费公开课,2小时]
  • Note: 部分课程的资料,PPT 等可以前往 连享会-直播课 主页查看,下载。

课程主页

课程主页

关于我们

  • Stata连享会 由中山大学连玉君老师团队创办,定期分享实证分析经验。
  • 连享会-主页知乎专栏,700+ 推文,实证分析不再抓狂。直播间 有很多视频课程,可以随时观看。
  • 公众号关键词搜索/回复 功能已经上线。大家可以在公众号左下角点击键盘图标,输入简要关键词,以便快速呈现历史推文,获取工具软件和数据下载。常见关键词:课程, 直播, 视频, 客服, 模型设定, 研究设计, stata, plus, 绘图, 编程, 面板, 论文重现, 可视化, RDD, DID, PSM, 合成控制法

连享会小程序:扫一扫,看推文,看视频……

扫码加入连享会微信群,提问交流更方便

✏ 连享会-常见问题解答:
https://gitee.com/lianxh/Course/wikis

New! lianxh 命令发布了:
随时搜索连享会推文、Stata 资源,安装命令如下:
. ssc install lianxh
使用详情参见帮助文件 (有惊喜):
. help lianxh