rroxygen2

How to display the elements of a returned list in Roxygen?


I can do this easily with input parameters by having multiple lines of @param by doing as such:

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

But how do you do that for the elements of a list you are returning. I want to include the names of each element and a description about them. Chaining together @return or @param does not have the same behavior. What is the appropriate tag?

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

The package samr has the exact markdown formatting I'm looking for:

enter image description here


Solution

  • From the documantation - http://r-pkgs.had.co.nz/man.html#text-formatting

    @return Used to document the object returned by the function. For lists, use the \item{name a}{description a} describe each component of the list.