如何在R中捕获含注释、命令及输出的Stata风格日志？

问题场景 #

需要实现类似Stata的日志功能，在单个R脚本内完整记录注释、执行的命令以及对应输出。尝试TeachingDemos::txtStart()会遗漏注释，sink()仅能捕获输出结果；使用sink()结合source('脚本路径', echo = TRUE)可以实现，但需要将代码拆分到两个文件，希望在单个脚本内完成需求。

解决方案1：使用logr包（推荐） #

logr是专门用于生成包含代码、注释和输出的日志工具，支持在单脚本内直接调用：

1. 安装并加载包：

install.packages("logr")
library(logr)

2. 单脚本内实现日志捕获：

# 初始化日志文件
lg <- log_open("my_analysis_log.txt")

# Step 1: 基础运算示例
1 + 2

# Step 2: 查看内置数据集前几行
head(iris)

# 关闭日志
log_close(lg)

生成的日志文件会完整保留所有注释、命令及输出，示例格式如下：

# 初始化日志文件
lg <- log_open("my_analysis_log.txt")

# Step 1: 基础运算示例
> 1 + 2
[1] 3

# Step 2: 查看内置数据集前几行
> head(iris)
  Sepal.Length Sepal.Width Petal.Length Petal.Width Species
1          5.1         3.5          1.4         0.2  setosa
2          4.9         3.0          1.4         0.2  setosa
3          4.7         3.2          1.3         0.2  setosa
4          4.6         3.1          1.5         0.2  setosa
5          5.0         3.6          1.4         0.2  setosa
6          5.4         3.9          1.7         0.4  setosa

# 关闭日志
log_close(lg)

解决方案2：无额外依赖的自引用脚本方法 #

如果不想安装新包，可以利用sys.source实现脚本自我调用，结合sink捕获内容：

log_file <- "self_contained_log.txt"

# 判断是否为首次运行，若是则触发自我source并捕获输出
if (!exists("run_as_source")) {
  run_as_source <- TRUE
  sink(log_file)
  sys_source(sys.frame(1)$ofile, envir = environment(), echo = TRUE)
  sink()
  invisible(quit(save = "no"))
}

# 以下是你的业务代码
# Step 1: 计算向量均值
mean(c(1,3,5,7))

# Step 2: 生成随机数并求和
sum(runif(5))

运行该脚本时，需选择"Source File"（而非逐行执行），生成的日志会包含注释、命令和输出，示例：

> # 以下是你的业务代码
> # Step 1: 计算向量均值
> mean(c(1,3,5,7))
[1] 4
> 
> # Step 2: 生成随机数并求和
> sum(runif(5))
[1] 2.6789  # 实际输出为随机值

方案对比 #

• logr包：功能丰富，支持日志归档、格式配置，使用门槛低，适合常规数据分析场景。
• 自引用方法：无需额外依赖，适合临时快速实现，但需注意运行方式，在交互式环境下可能需要调整执行逻辑。

内容的提问来源于stack exchange，提问作者braces