r - 可以在 roxygen2 代码块中使用换行符吗？

Question

我想知道在记录函数时是否可以在 roxygen2 的代码块中插入换行符？

如果我在里面有东西\code{}，roxygen2 默认将所有换行符折叠成单个空格。我尝试\cr在里面插入以强制换行，我得到了所需的行为，但是当我“R CMD CHECK”时我得到了一个警告。有没有办法做到这一点？

例子：

#' \code{
#'   multiple
#'   lines
#' }

Answer 1

使用\preformatted而不是\code. \code用于内联代码（在 SO 上工作``）并且\preformatted用于逐字块（如在 SO 上缩进）。

#' \preformatted{
#'   multiple
#'   lines
#' }

请注意，紧随其后的初始换行符{也将成为代码块的一部分，因此您可能需要考虑将其删除。