如何在 Roxygen 中显示返回列表的元素？答案

【问题标题】：How to display the elements of a returned list in Roxygen?如何在 Roxygen 中显示返回列表的元素？
【发布时间】：2016-05-07 18:24:51
【问题描述】：

我可以通过输入参数轻松地做到这一点，方法是通过多行 @param 这样做：

#' @param var1 This is for x
#' @param var2 This is for y
#' @param var3 This is for Z

但是对于要返回的列表的元素，您如何做到这一点。我想包括每个元素的名称和关于它们的描述。链接在一起 @return 或 @param 没有相同的行为。什么是合适的标签？

#' @return A list with the following elements:
#' @something element1 Contains x
#' @something element2 Contains y
#' @something element3 Contains z

samr 包具有我正在寻找的确切降价格式：

【问题讨论】：

标签： r roxygen2

【解决方案1】：

来自文档 - http://r-pkgs.had.co.nz/man.html#text-formatting

@return 用于记录函数返回的对象。对于列表，使用 \item{name a}{description a} 描述列表的每个组成部分

【讨论】：

做到了。我使用的是\itemize，这改变了格式。

【解决方案2】：

由于在接受的答案中链接被破坏，我提供了一个简单的 roxygen 文档示例，该函数提供了一个列表作为返回值。

#' Sample function that returns a list and uses roxygen documentation.
#'
#'
#' @return A list with letters and numbers.
#' \itemize{
#'   \item A - The letters of the alphabet.
#'   \item B - A vector of numbers.
#' }
myfunction <- function() {
  list(
    A = LETTERS,
    B = 1:10
  )
}

假设你的包名为mypackage，上面的代码有助于在运行?mypackage::myfunction时生成类似于下面输出的文档。

这是基于R packages - Object Documentation - Text formatting reference sheet 的链接

【讨论】：

如果项目的长度不同，列表将不会很好地对齐。 item{name a}{description a} 在这种情况下会更好。
@ccshao 谢谢，当我有更多时间测试我的解决方案时，我会添加该选项。