Stata论文复现:做一个优雅的码农
(2022-04-28 15:02:02)
标签:
stata论文复现规范化代码 |
分类: Stata推文 |
全文阅读:https://lianxh.cn/news/209224ad5a102.html
前言:本文亮点速览
使用杂乱无章的代码写作习惯就像背上高息的“技术债务”,不仅使得今后的代码维护变得困难而耗时,而且使得他人几乎不可能重复文章的结果。
本文翻译并整理了 Michael Stepner
团队的代码风格文档,并复制了其团队
2016 年发表在 JAMA 的
- 在处理流程上,遵循原始数据--->派生数据--->临时文件或结果的顺序
- 在具体实现上,文件夹应当大致划分为代码、原始数据、派生数据、临时文件和结果这五个文件夹。
- 代码文件夹中最好包含项目使用的从 SSC 上下载的 ado 文件
- 原始数据文件夹中最好包含一个 source.txt 文件以说明数据来源
- 临时文件夹中的文件最好进行描述性的、唯一的命名
- 编写的 do 文件应当尽量简短、独立、专用
- 使用相对路径而非绝对路径
- 变量名称设置应当尽量描述性、有意义、不易产生歧义
- 数据集应当具有一组独特 ID
- 将运行在需要满足的假设条件以代码形式写出,而非仅仅注释
- 避免重复的代码,可以使用循环语句、program 语句、ado 文件等方式解决代码重复问题
- 使用 project 命令实现程序的自动化
开始我们的优雅代码之旅吧!