Как отобразить элементы возвращаемого списка в 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- Документация по объектам - Справочный лист по форматированию текста