man-roxygen/class_schema_accessors.R

In jeanmathieupotvin/cargo: Data containers, schemas and prototypes

# class_schema_accessors.R


#' @name Schema-accessors
#'
#' @title
#' Schema: get or set slots
#'
#' @description
#' Get or set the values stored in slots of an object of class
#' [`Schema`][Schema-class].
#'
#' @param x conceptually, any \R object.
#' @param value depends of the function used.
#' * For [`inputs<-()`], a `character`. It must have names that match existing
#' names in `x`.
#' * For [`prototypes<-()`], a `list`. It must have names that match existing
#' names in `x`.
#'
#' @return
#' [inputs()] returns a named character vector.
#'
#' [prototypes()] returns a named list.
#'
#' Functions [`inputs<-()`][inputs()], [`prototypes<-()`][prototypes()] and
#' [`constructor<-()`][constructor()] update `x` and return its updated version
#' invisibly.
#'
#' @family Schema