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)}

这是我使用的repo中的一个实际示例\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 repo,SOdemoing,用于测试这样的事情(更详细的包相关问题和答案).请参阅FUN.R,我在其中测试两种方法roxygen2,然后在我设置它的结果帮助手册中(同样功能是FUN.R).