man-roxygen/class_container_methods.R

In jeanmathieupotvin/cargo: Data containers, schemas and prototypes

# class_container_methods.R


#' @name Container-methods
#'
#' @title
#' Container: various methods for objects of class Container
#'
#' @description
#' Some usual \R methods for objects of class [`Container`][Container-class].
#'
#' @param x a [`Container`][Container-class] object.
#'
#' @return
#' Return value depends on the function used.
#' * [length()], [nrow()], [ncol()] and [dim()] all return an integer.
#' * [names()] returns a character vector.
#'
#' @family Container