研究数据集 README 怎样写清文件、变量和使用条件？

把研究数据文件交给别人时，一份 README 应先解决三个问题：这里有哪些文件，各列或代码表示什么，以及从哪里开始才能正确使用。README 是数据集的入口说明，重复一遍论文摘要仍不足以让人使用文件。Dryad 的数据提交说明把数据描述、文件与变量、代码与软件、访问方式列为 README 的主要内容，可据此检查自己的说明是否足够让他人理解数据。

先说清文件关系

开头用两三句交代数据对应的研究问题、采集对象和时间范围，再列出文件名与作用。例如自拟的校园阅读调查资料包包括 responses_clean.csv、codebook.csv 和 analysis.R：第一份是去标识化的分析数据，第二份解释变量与取值，第三份生成论文中的描述统计。若另有原始表或敏感信息文件，说明其未公开的原因与保管方式，不在 README 中泄露路径、姓名或密钥。

文件关系不能只靠“见附件”。应告诉读者哪些是原始输入，哪些经过清理；一份脚本读取哪个文件，运行后产生什么输出；若论文表格来自某个汇总文件，也可标明对应关系。版本号和更新时间有帮助，特别是文件经过订正时，让读者知道 README 与哪一版数据相配。

变量说明写到不会误读

数据表中的 score、group、空白值若没有解释，读者无法判断它们是什么。可以写：“group 为课程组别，1 表示甲组、2 表示乙组；score 为问卷五题得分之和，范围 5 至 25；空白表示该题未作答，不等于 0。”这里是自拟的格式示范，不是实际调查结果。真实数据还应交代计量单位、分母、日期格式、缺失编码和衍生变量的计算办法。已有独立数据字典时，README 给出文件位置和关键规则即可，无需逐列重复所有内容。

有些文件需特定软件或编码方式打开，也应写出足以运行的环境信息，包括软件名称、版本范围、主要依赖和推荐的运行顺序。若无法公开原始脚本，至少说明公开文件如何生成以及不能复现的部分，避免让“可复现”成为没有操作依据的口号。软件版本并非越细越好，真正会影响读取或输出的依赖才需要重点注明。

说明访问和再利用条件

README 最后交代数据能否下载、引用时应标注什么、是否有许可证或伦理限制，以及遇到问题可联系谁。可公开的去标识数据与需要审批的敏感数据应分别说明，不把“作者同意后使用”写成含糊的万能许可。若数据存于资料库，优先遵守该库的字段与许可设置，README 负责补足理解所需背景。

检查方法很简单：让未参与整理的合作者只读 README 和公开文件，试着找到论文某张表使用的数据、解释一个关键变量、运行最基础的读取步骤。卡住的位置，就是需要补写的文件关系或定义。资料依据为 Dryad《Creating a README》及其数据提交指导。