r - roxygen2 手动插入换行符

Question

我有一个我想用 roxygen2 记录的函数：

#' Name of function
#' 
#' Description
#' 
#' @param x The input data
#' @param method one of:
#' "method1" - very long text here 
#' "method2" - very long text here
#' "method3" - very long text here
#' "method4" - very long text here 
#' "method5" - very long text here 
#' "method6" - very long text here 
#' "method7" - very long text here 
#' "method8" - very long text here 
#' "method9" - very long text here 
#' "method10" - very long text here 
myfun <- function (x, method){return(NULL)}

这个函数有大约 10 种不同的方法，每一种都有很长的描述。我希望每个“方法”之间有一个换行符，以便于快速查看可用的不同方法。

正如所写，当我打电话时roxygenize('mypackage')，上面的文字被压缩成一行。

如何在 roxygen2 文档中手动插入换行符？

Answer 1

这有效：

#' Name of function
#' 
#' Description
#' 
#' @param x The input data
#' @param method one of: \cr 
#' "method1" - very long text here \cr 
#' "method2" - very long text here \cr 
#' "method3" - very long text here \cr 
#' "method4" - very long text here \cr 
#' "method5" - very long text here \cr 
#' "method6" - very long text here \cr 
#' "method7" - very long text here \cr 
#' "method8" - very long text here \cr 
#' "method9" - very long text here \cr 
#' "method10" - very long text here \cr 
myfun <- function (x, method){return(NULL)}

这是我使用的仓库中的一个实际示例\cr： https ://github.com/trinker/SOdemoing/blob/master/R/FUN.R

@Gregor 的评论也很受欢迎。那看起来像：

#' @param method2 one of:
#' \itemize{
#'   \item method1 - very long text here 
#'   \item method2 - very long text here
#'   \item method3 - very long text here
#'   \item method4 - very long text here 
#'   \item method5 - very long text here 
#'   \item method6 - very long text here 
#'   \item method7 - very long text here 
#'   \item method8 - very long text here 
#'   \item method9 - very long text here 
#'   \item method10 - very long text here 
#' }

在这里您可以看到两者的输出：

我创建了一个GitHub 存储库 SOdemoing来测试这样的事情（更详细的包相关问题和答案）。请参阅我测试这两种方法的FUN.Rroxygen2 ，然后查看我设置它的结果帮助手册（再次功能是 FUN.R）。