如何格式化类似于参数列表的roxygen2返回列表?

时间:2019-08-28 01:03:08

标签: roxygen2

我注意到,使用\describe{}创建返回对象的列表的格式与在我从CRAN下载的软件包的文档中所看到的格式不同。我如何模仿他们的风格?请参见下面的图片进行比较。我用来生成第一个代码是:

#' @return A list containing:\describe{
#'    \item{pars}{A numeric vector of parameter estimates}
#'    \item{std.errs}{A numeric vector of standard errors on parameters}
#'    \item{cov.mat}{Parameter covariance matrix (excluding mean)}
#' }

My cruddy documentation Gorgeous fancy documentation

1 个答案:

答案 0 :(得分:0)

我知道了。您需要使用表格环境,代码文本格式和其他行。下面的代码有效。

#' @return A list containing:\tabular{ll}{
#'    \code{pars} \tab A numeric vector of parameter estimates \cr
#'    \tab \cr
#'    \code{std.errs} \tab A numeric vector of standard errors on parameters \cr
#'    \tab \cr
#'    \code{cov.mat} \tab Parameter covariance matrix (excluding mean) \cr
#' }

enter image description here