ready4use_dictionary: ready4 s3 class defining a data dictionary tibble.

View source: R/C3_ready4use_dictionary.R

ready4use_dictionaryR Documentation

ready4 s3 class defining a data dictionary tibble.

Description

Create a new valid instance of the ready4 s3 class defining a data dictionary tibble.

Usage

ready4use_dictionary(x = make_pt_ready4use_dictionary())

make_pt_ready4use_dictionary(
  var_nm_chr = character(0),
  var_ctg_chr = character(0),
  var_desc_chr = character(0),
  var_type_chr = character(0)
)

is_ready4use_dictionary(x)

Arguments

x

An object of any type

var_nm_chr

Variable name (a character vector), Default: character(0)

var_ctg_chr

Variable category (a character vector), Default: character(0)

var_desc_chr

Variable description (a character vector), Default: character(0)

var_type_chr

Variable type (a character vector), Default: character(0)

Details

A data dictionary tibble.

Value

A validated instance of the ready4 s3 class defining a data dictionary tibble.

A prototype for ready4 s3 class defining a data dictionary tibble.

A logical value, TRUE if a valid instance of the ready4 s3 class defining a data dictionary tibble.


ready4-dev/ready4use documentation built on June 1, 2025, 2:06 p.m.