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

Question

我可以通过输入参数轻松地做到这一点,@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具有我正在寻找的确切降价格式:

Answer 1

从手册 - http://roxygen.org/roxygen2-manual.pdf

@return用于记录函数返回的对象.对于列表,使用\ item {name a} {description a}描述列表的每个组件

Answer 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 包的链接- 对象文档 - 文本格式参考表