iii_help: Integrity properties

In j-martineau/uj: Utilities by JAM

Integrity properties

Description

Integrity properties are defined for populated atomic data.frames, populated atomic vlists, populated atomic vectors, and populated atomic arrays. For all others, all integrity properties are considered FALSE. The following table summarizes valid integrity properties.

⁠'cmp', 'CMP'⁠	complete	Populated and atomic vectors, arrays, data.frames, and vlists containing no NA values.
⁠'mss', 'MSS'⁠	missing	Populated and atomic vectors, arrays, data.frames, and vlists containing only NA values.
⁠'prt', 'PRT'⁠	partial	Populated and atomic vectors, arrays, data.frames, and vlists containing NA and non-NA values.
⁠'dup', 'DUP'⁠	duplicates	Complete and containing duplicate values.
⁠'unq', 'UNQ'⁠	unique	Complete and containing only unique values.
⁠'nas', 'NA0'⁠	NA scalar	Atomic scalar NA.
⁠'oks', 'OK0'⁠	OK scalar	Non-NA atomic scalar.

Usage

iii_help()

iii(x)

iii_funs()

iii_props()

is_iii_spec(spec)

III(x, spec, ...)

CMP(x, ...)

MSS(x, ...)

NA0(x, ...)

OK0(x, ...)

PRT(x, ...)

DUP(x, ...)

UNQ(x, ...)

Arguments

x	An R object.
spec	NULL or a complete character vec containing one or more integrity properties (i.e., from iii_props()). Integrity properties may be pipe-delimited. If there are multiple properties in spec, x is inspected for a match to any of the specified properties.
...	Arguments passed on to meets

Functions

• iii(): Lists all integrity properties of x. Returns a sorted, lowercase, character vector.

• iii_funs(): Lists all integrity property checking functions. Returns a sorted, uppercase, character vector.

• iii_props(): Lists all integrity properties. Returns a sorted, lowercase, character vector.

• is_iii_spec(): Checks whether spec is an integrity property spec. Returns a logical scalar. See ppp for a definition of a property spec.

• III(): Checks x against the integrity property spec spec. Returns a logical scalar. See ppp for a definition of a property spec.

• CMP(): Checks x for completeness subject to any count or value restrictions in .... Returns a logical scalar.

• MSS(): Checks x for missingness subject to any count or value restrictions in .... Returns a logical scalar.

• NA0(): Checks x for whether it is a missing-value scalar subject to any count or value restrictions in .... Returns a logical scalar.

• OK0(): Checks x for whether it is a non missing-value scalar subject to any count or value restrictions in .... Returns a logical scalar.

• PRT(): Checks x for partial completeness subject to any count or value restrictions in .... Returns a logical scalar.

• DUP(): Checks x for duplicatedness subject to any count or value restrictions in .... Returns a logical scalar.

• UNQ(): Checks x for uniqueness subject to any count or value restrictions in .... Returns a logical scalar.

Specifying count and value restrictions

Specifying restrictions in ... is optional. The full set of recognized arguments names are defined in the following table along with the properties each specifies:

⁠.max, .maxr, .maxc⁠	Scalar maximum valid numbers of elements, rows, and columns, respectively.
⁠.min, .minr, .minc⁠	Scalar minimum valid numbers of elements, rows, and columns, respectively.
⁠.lt, .le, .ge, .gt⁠	Complete sortable scalar less-than, less-than-or-equal, greater-than-or-equal, and greater-than bounds, respectively.
⁠.n, .nr, .nc⁠	A vector of valid numbers of elements, rows, and columns, respectively.
.vals	A vector of valid values.

See Also

Other properties: as_mmm(), bbb_ccc_help(), bbb_help(), bbb_mmm_prop_funs(), ccc_help(), cls(), cmp_ccc_help(), cmp_mmm_ccc_help(), cmp_mmm_help(), compatible(), ddd_prop_funs(), eee_help(), meets(), mmm_ccc_help(), mmm_help(), ppp_fast_help(), ppp_help(), sss_ccc_help(), sss_prop_funs(), unq_ccc_prop_funs(), unq_mmm_ccc_help(), unq_mmm_help()

Examples

iii_funs()
iii_props()
is_iii_spec("nas|mss")
CMP(NA)
CMP(NULL)
NA0(NA)
OK0(letters)
OK0(letters[1])
MSS(rep(NA, 10))
iii(NA)
iii(letters)
iii(letters[1])

j-martineau/uj documentation built on Sept. 14, 2024, 4:40 a.m.