man-roxygen/class_schema_validators.R

In jeanmathieupotvin/cargo: Data containers, schemas and prototypes

# class_schema_validators.R


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