man-roxygen/class_container_validators.R

In jeanmathieupotvin/cargo: Data containers, schemas and prototypes

# class_container_validators.R


#' @name Container-validators
#'
#' @title
#' Container: validate an object of class Container
#'
#' @description
#' Test if an object is a proper [`Container`][Container-class] object.
#'
#' @param x,object an object of class [`Container`][Container-class].
#'
#' @return
#' Function [valid_container()] returns a logical `TRUE` if the object is valid.
#' Else, it returns an error message describing the problems.
#'
#' Function [.valid_container()] returns `NULL` if the object is valid. Else,
#' it returns a character vector of strings describing the problems.
#'
#' @details
#' Function [valid_container()] is a user-friendly wrapper to
#' [.valid_container()] and further checks if `x` is of class
#' [`Container`][Container-class].
#'
#' @family Container