man-roxygen/class_container_accessors.R

In jeanmathieupotvin/cargo: Data containers, schemas and prototypes

# class_container_accessors.R


#' @name Container-accessors
#'
#' @title
#' Container: get or set slots
#'
#' @description
#' Get or set the values stored in slots of an object of class
#' [`Container`][Container-class].
#'
#' @param x conceptually, any \R object.
#' @param value depends of the function used.
#' * For [`table<-()`], a [`data.table`][data.table::data.table()].
#' * For [`schema<-()`], a [`Schema`][Schema-class] object.
#' Beware of mismatches bewteen slots `table` abd `schema`.
#'
#' @return
#' [table()] returns a [`data.table`][data.table::data.table()].
#'
#' [schema()] returns a [`Schema`][Schema-class] object.
#'
#' Functions [`table<-()`][table()] and [`schema<-()`][schema()] update `x`
#' and return its updated version invisibly.
#'
#' @family Container