r - 如何在 roxygen 识字编程中转义 %？

Question

我的函数的一个参数的默认值包含一个“%”。这似乎是 roxygen 的一个问题，它会在尝试构建 latex 文档时产生很多警告并且 R CMD 检查失败。

我怎样才能使这个功能(及其文档)工作？使用 %% 或\% 而不是 % 没有帮助。

#' Test escape \% from in-source documentation (roxygen).
#'
#' What happens when parameters contain special latex characters? 
#'
#' @param x unsuspicious parameter 
#' @param format sprintf format string (default "\%5.0f")
#'
#' @return formatted string
#' @export
#' @author Karsten Weinert
testroxy <- function(x, format = "%5.0f") {
  sprintf(format,x)
}

Answer 1

与问题中的代码类似的代码对我来说没有问题，并生成正确的文档。正如多条评论所说，原因一定是我使用的是 roxygen2 包。因此，只需使用 roxygen2，然后使用反斜杠在文档中转义“%”:

#' The percentage sign is written in the documentation like this: \%.