如何为自定义R函数添加非错误提示消息以打印回归公式

我编写了一个自定义R函数，用于模型构建与项提取，示例代码如下：

myfunction <- function(data, outcome1, predictor1, predictor2){
  modelx <- glm(reformulate(predictor1, outcome1), data = data)
  modelx$aic
}

myfunction(data = mtcars, outcome1 = "mpg", predictor1 = "cyl")

实际场景中该函数返回一个数据框，此处为简化问题做了精简。

我希望为该函数添加提示消息，使函数运行时自动打印调用的回归公式。在函数外部运行以下代码可得到该公式：

> reformulate("cyl", "mpg")
mpg ~ cyl

我尝试在函数末尾添加类似simpleMessage(reformulate(predictor1, outcome1))的代码，但无法正常运行。我了解这与函数只能返回一个输出值有关，请问该如何实现需求？

解决方案 #

函数确实默认只返回最后一行的结果，但你可以先执行打印提示的操作，再返回目标结果——打印属于副作用操作，不会占用函数的返回值，只要把打印代码放在返回语句之前即可。

方法1：用message()拼接文本输出公式 #

myfunction <- function(data, outcome1, predictor1, predictor2){
  # 生成公式并转为字符串，拼接提示文本后打印
  formula <- reformulate(predictor1, outcome1)
  message("当前调用的回归公式：", deparse(formula))
  
  # 构建模型并返回目标结果
  modelx <- glm(formula, data = data)
  modelx$aic
}

# 测试调用
myfunction(data = mtcars, outcome1 = "mpg", predictor1 = "cyl")

运行后会先输出提示消息，再返回AIC值：

当前调用的回归公式：mpg ~ cyl
[1] 168.4232

方法2：用print()直接输出原生格式的公式 #

如果希望公式以更标准的统计格式显示（保留~的原生样式），可以直接打印公式对象：

myfunction <- function(data, outcome1, predictor1, predictor2){
  formula <- reformulate(predictor1, outcome1)
  print("当前调用的回归公式：")
  print(formula)
  
  modelx <- glm(formula, data = data)
  modelx$aic
}

# 测试调用
myfunction(data = mtcars, outcome1 = "mpg", predictor1 = "cyl")

运行输出：

[1] "当前调用的回归公式："
mpg ~ cyl
[1] 168.4232

关键说明 #

• message()和print()都是副作用函数，它们的输出直接打印到控制台，不会影响函数的返回值。
• 先执行打印操作，再编写返回语句（比如modelx$aic），函数最终会返回最后一行的结果，同时完成提示消息的输出。
• deparse(formula)可以把公式对象转换为字符串，方便和自定义提示文本拼接后输出。

内容的提问来源于stack exchange，提问作者Betsy S.