如何格式化类似于参数列表的 roxygen2 return 列表？

Question

我注意到使用 \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)}
#' }

Answer 1

我明白了。您需要使用表格环境、代码文本格式和附加行。以下代码有效。

#' @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
#' }

如何格式化类似于参数列表的 roxygen2 return 列表？

How do I format roxygen2 return list similar to parameter list?

roxygen2