R/cargo_package.R

In jeanmathieupotvin/cargo: Data containers, schemas and prototypes

# cargo_package.R


#' @rdname cargo_package
#' @name cargo-package
#'
#' @title
#' \pkg{cargo} :: Data containers, schemas and prototypes
#'
#' @section Cargo has arrived, and it brings *containers*:
#' Package \pkg{cargo} defines various types of containers. The
#' [`Container`][Container-class] S4 class is the package's central class: a
#' [`Container`][Container-class] is a table that holds data according to an
#' explicit table [`Schema`][Schema-class]. It relies on the mechanims of the
#' powerful \pkg{data.table} package whenever it is possible.
#'
#' All classes are [S4 classes][methods::methods-package]. They can very
#' easily be extended to super-classes.
#'
#' \if{html}{\figure{cargo_classes_simplified.svg}{options: style="display: block;margin-left: auto;margin-right: auto; width: 90%;" alt="Cargo classes schema"}}
#'
#' @keywords internal
"_PACKAGE"