R/listWrappers.R

Defines functions listWrappers

Documented in listWrappers

#' @title Lists Implemented Distribution Wrappers
#' @description Lists wrappers that can wrap an R6 Distribution.
#' @param simplify logical. If TRUE (default) returns results as characters, otherwise as R6
#' classes.
#' @seealso \code{\link{DistributionWrapper}}
#' @return Either a list of characters (if `simplify` is `TRUE`) or a list of `Wrapper` classes.
#' @examples
#' listWrappers()
#' listWrappers(TRUE)
#' @export
listWrappers <- function(simplify = TRUE) {
  y <- .distr6$wrappers[order(names(.distr6$wrappers))]
  if (simplify) {
    return(names(y))
  } else {
    return(y)
  }
}

Try the distr6 package in your browser

Any scripts or data that you put into this service are public.

distr6 documentation built on March 28, 2022, 1:05 a.m.