man-roxygen/class_schema_constructor.R

In jeanmathieupotvin/cargo: Data containers, schemas and prototypes

# class_schema_constructor.R


# Always merged with class_schema.R.


#' @param inputs a named `character` of `name = value` pairs. Names are optional.
#' @param prototypes a named `list` of `name = value` pairs. Values must be
#' objects of class [`Prototype`][Prototype-class].
#' @param ... further arguments passed to or from methods.
#'
#' @return
#' The constructor [Schema()] returns an object of class [`Schema`][Schema-class].
#'
#' @details
#' The constructor [Schema()] is flexible in its name management.
#'
#' * Names can be missing. Then, default matching tags are automatically
#' generated.
#' * Names can be passed to [Schema()] only once through either `inputs` or
#' `prototypes`. In that case, they are reused elsewhere.