←
PDF 506 / 520 Much of the good advice about using lab notebooks effectively can also be translated to analysis
→
English · PDF 506
Original PDF page 506
中文 · PDF 506

许多关于有效使用实验记录本的好建议同样适用于分析笔记本。我结合自己的经验以及 Colin Purrington 关于实验记录本的建议(http:// colinpurrington.com/tips/lab-notebooks)总结出以下提示:

  • 确保每个笔记本都有一个描述性的标题、一个易于辨识的文件名,以及一段简要描述分析目标的开头段落。
  • 使用 YAML 头部的 date 字段记录你开始处理该笔记本的日期:

date: 2016-08-23

请使用 ISO8601 YYYY-MM-DD 格式,以免产生歧义。即使你平时不这样写日期,也要坚持使用这种格式!

  • 如果你在一个分析想法上花费了大量时间,结果却发现是条死路,不要删除它!写一段简短的笔记说明它为什么失败,并保留在笔记本中。这能帮助你在将来重新回到这个分析时避免重蹈覆辙。
  • 一般来说,最好在 R 之外进行数据录入。但如果你确实需要记录一小段数据,请使用 tibble::tribble() 清晰地排版。
  • 如果你发现数据文件中有错误,切勿直接修改它,而应编写代码来纠正该值,并解释你进行修正的原因。
  • 在结束一天的工作之前,确保你能够编织(knit)笔记本(如果你使用了缓存,请务必清除缓存)。这样你就能趁代码还记忆犹新时解决任何问题。
  • 如果你想让你的代码在长期内可复现(即,以便你能在下个月或明年回来重新运行它),你需要跟踪你的代码所使用的包的版本。一种严格的方法是使用 packrat,它将包存储在你的项目目录中,或者使用 checkpoint,它会重新安装指定日期可用的包。一种快速而粗糙的技巧是包含一个运行 sessionInfo() 的代码块——这不能让你轻松地按今天的原样重新创建你的包,但至少你会知道它们是什么。