如何在R Sweave编译PDF时让自定义函数的输出文本自动换行

问题说明 #

使用Sweave编译PDF文件时，自定义函数的输出文本无法自动换行，会超出页面边界导致内容不可读。和实际使用的自定义函数输出逻辑相近的示例代码如下：

\documentclass{article}

\begin{document}
\SweaveOpts{concordance=TRUE}

<<>>=
long_output <- function(x,group){
  var1 <- paste0(group, "_", x, ".devcmn")
  var2 <- paste0(group, "_", x, ".cmn")
  resNames <- c(var1,var2)
  class(resNames) <- "long_output"
  return(resNames)
}

print.long_output <- function(x){
  cat("The following variables (group summary, deviation) were added to the dataset:", x[1], x[2], '\n')
  cat("See package documentation for detailed description of variables added.")
}

long_output("Variable","Grouping")
@

\end{document}

需求为找到适用于Sweave的解决方案，调用函数后其输出内容可自动在PDF页边距范围内换行，优先考虑无需修改函数本身的方案。

可行解决方案 #

以下方案按侵入性从低到高排序，优先使用第一种即可。

方案1：LaTeX导言区配置（无需修改任何R代码） #

Sweave默认使用listings宏包输出代码和运行结果，只需在LaTeX导言区添加如下配置，即可全局开启输出内容自动换行：

\usepackage{listings}
\lstset{
  breaklines=true, % 开启自动换行
  breakatwhitespace=false, % 允许在非空格位置换行
  basicstyle=\ttfamily\small % 可选：调整输出字体大小进一步适配页面
}

配置后重新编译即可生效，不需要修改任何自定义函数、R代码逻辑。

方案2：R全局输出宽度配置（仅需添加1行R代码） #

如果因为Sweave版本差异导致上述LaTeX配置不生效，可以在第一个R代码块开头添加全局宽度配置：

options(width = 65)

数值可根据实际页面宽度调整，常规A4纸默认页边距下设置为60-70即可适配。Sweave会按照指定宽度自动对输出内容换行，也不需要修改自定义函数本身。

方案3：调用侧包裹适配（无需修改原函数逻辑） #

如果前两种方案都不符合使用场景，可以在调用自定义函数时加一层输出处理，不需要修改原函数的定义：

# 原调用代码：long_output("Variable","Grouping")
# 替换为：
invisible(
  long_output("Variable","Grouping") 
  |> capture.output() 
  |> strwrap(width = getOption("width")) 
  |> cat(sep = "\n")
)

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