man-roxygen/draws_format-skeleton.R

In stan-dev/posterior: Tools for Working with Posterior Distributions

#' @description
#'   The `<%=paste0("as_", draws_format, "()")%>` methods convert
#'   objects to the `<%=draws_format%>` format.
#'   The `<%=paste0(draws_format, "()")%>` function creates an object of the
#'   `<%=draws_format%>` format based on a set of numeric vectors.
#'   See **Details**.

# Shared arguments

#' @param x An object to convert to a `<%=draws_format%>` object.
#' @param ... For `<%=paste0("as_", draws_format, "()")%>`:
#'   Arguments passed to individual methods (if applicable).
#'   For `<%=paste0(draws_format, "()")%>`: Named
#'   arguments containing numeric vectors each defining a separate variable.

# The @return template also uses a base_class template variable because
# although could determine base_class just from sub("draws_", "", draws_format),
# that doesn't work for draws_df since it isn't a "df" but rather a
# c("tbl_df", "tbl", "data.frame").

#' @return A `<%=draws_format%>` object, which has classes
#' `c("<%=draws_format%>", "draws", <%=base_class%>)`.

# An example that can be used for all formats to demonstrate the structure, but
# we can always add format-specific examples by also explicitly adding an
# @examples section to the format-specific pages. See for example the draws_df
# documentation, which includes this example plus another one.

#' @examples
#' x1 <- <%=paste0("as_", draws_format)%>(example_draws())
#' class(x1)
#' print(x1)
#' str(x1)
#'
#' x2 <- <%=draws_format%>(a = rnorm(10), b = rnorm(10), c = 1)
#' class(x2)
#' print(x2)
#' str(x2)