通过roxygen2在R文档中生成具有多个参数的项

要生成R文档文件（

.Rd

），我使用R3.0.2、Linux 3.11、devtools 1.5、roxygen2 4.0.1中的包RStudio/Document选项

客观的 我想在文档文件中描述函数的多个参数，例如在本例中：

\arguments{
  \item{arg1, arg2}{Description}
}

这里，参数

arg1

和

arg2

被空格字符分割。这会导致HTML版本自动换行

问题 使用RStudio/Document选项，两个参数之间的空格将第二个参数置于“说明”部分，例如：

#' @param arg1, arg2 Description

将成为

\arguments{
  \item{arg1,}{arg2 Description}
}

\arguments{
  \item{arg1,arg2}{Description}
}

不当解决方案 我认为将两个参数都保留在“参数”部分的唯一方法是不使用空格分隔，例如：

#' @param arg1,arg2 Description

将成为

\arguments{
  \item{arg1,}{arg2 Description}
}

\arguments{
  \item{arg1,arg2}{Description}
}

这是不需要的，因为参数数量较多时，带有参数的“列”会占用大量空间。我试图用

\

或

\\

跳出空格，并用

\code{…}

插入所有参数，但没有一个按预期工作

问题: 有没有办法像我的目标中那样创建输出？也许是某个引入空格的转义字符

谢谢。

---

Sven

我还没有找到一种方法说服

roxygen2

让您生成参数之间有空格的行，但是您可以在调用

roxygenize

后手动更新Rd文件

library(stringr)
filename <- "your package root/man/your_function.Rd"
lines <- readLines(filename)
lines <- str_replace(lines, fixed("\item{arg1,arg2}"), "\item{arg1, arg2}")
writeLines(lines, filename)

库（stringr）
文件名现在似乎可以与roxygen2 6.0.1一起使用：

#' @param arg1,arg2 Description

（逗号后无空格）给出

（逗号后加空格）。
生成手册页的是
roxygen2
包，而不是
devtools
。因此
devtools
使用
roxygen2
？是的。如果查看
packageDescription（“devtools”）
，您将看到
roxygen2
位于“建议”部分。这意味着使用了
roxygen2
，但使用了
devtools
，但不是必须的。（例如，您可以使用
devtools
，但可以手动编写文档，在这种情况下，您不需要
roxygen2
）谢谢，在我的问题中澄清了这一点。这方面有什么新闻吗？你有没有在roxygen2上提交过一个问题？@Henrik我没有提交问题，但是你可以自己提交一个。