R/code.R

In rappster/instancer: Simple instantiation for S3

#' @title
#' Create instance object
#'
#' @description
#' Convenience wrapper around `structure()`.
#'
#' @details
#' None yet.
#'
#' @param of \code{\link{character}}.
#' Name of the class for which an instance should be created.
#' @param with \code{\link{ANY}}.
#' Any object that should act as the actual data of the instance.
#' @param inherits \code{\link{logical}}.
#' \code{TRUE}: resulting object inherits from class(es) of \code{with}.
#' \code{FALSE} (default): resulting object only has class \code{of}.
#' @param attributes \code{\link{list}}
#' Attributes to be passed along to the instance. Supply as a named list.
#' @example inst/examples/createInstance.R
#' @seealso \code{
#'   	\link[instancer]{TODO}
#' }
#' @template authors
#' @template references
#' @export
createInstance <- function(
  of,
  with = NA,
  inherits = TRUE,
  attributes = NULL
) {
  if (inherits(with, "data.frame") & !inherits) {
    stop("Data frames are automatically be turned into lists if `inherits = FALSE`\nUnclass input or provide explicit list input")
  }
  cls <- if (inherits)
    unique(c(of, class(with))) else of

  if (!length(attributes)) {
    structure(with, class = cls)
  } else {
    do.call(structure, args = c(list(.Data = with, class = cls), attributes))
  }
}

#' @title
#' Create instance object
#'
#' @description
#' Convenience wrapper around `structure()`.
#'
#' @details
#' None yet.
#'
#' @param of \code{\link{character}}.
#' Name of the class for which an instance should be created.
#' @param with \code{\link{ANY}}.
#' Any object that should act as the actual data of the instance.
#' @param inherits \code{\link{logical}}.
#' \code{TRUE}: resulting object inherits from class(es) of \code{with}.
#' \code{FALSE} (default): resulting object only has class \code{of}.
#' @param attributes \code{\link{list}}
#' Attributes to be passed along to the instance. Supply as a named list.
#' @example inst/examples/create_instance.R
#' @seealso \code{
#'   	\link[instancer]{TODO}
#' }
#' @template authors
#' @template references
#' @export
#' @export
create_instance <- createInstance