sss_ccc_help: Combo Shape and Extended Class Properties

In j-martineau/uj: Utilities by JAM

Combo Shape and Extended Class Properties

Description

These functions check for the combination of shape and extended class properties.

Some combinations of shape and extended class are nonsensical. That includes:

• Shapes emp (empty) and pnt (point) combined with extended classes mvc (multivec) or scl (scalar).

• Shapes row, col (column), or rct (rectangular) combined with extended classes other than dtf (data.frame) or mat (matrix),

• Shape sqr (square) combined with any extended class other than mat (matrix).

Nonsensical combinations do not have corresponding sss_ccc property functions.

Usage

sss_ccc_help()

sss_ccc(x, sss, ccc, ...)

sss_ccc_funs()

sss_ccc_props()

emp_arr(x, ...)

emp_dtf(x, ...)

emp_gen(x, ...)

emp_mat(x, ...)

emp_vec(x, ...)

emp_vls(x, ...)

pnt_arr(x, ...)

pnt_dtf(x, ...)

pnt_gen(x, ...)

pnt_mat(x, ...)

pnt_scl(x, ...)

pnt_vec(x, ...)

pnt_vls(x, ...)

lin_arr(x, ...)

lin_dtf(x, ...)

lin_gen(x, ...)

lin_mat(x, ...)

lin_mvc(x, ...)

lin_vec(x, ...)

lin_vls(x, ...)

col_dtf(x, ...)

col_mat(x, ...)

row_dtf(x, ...)

row_mat(x, ...)

rct_dtf(x, ...)

rct_mat(x, ...)

sqr_mat(x, ...)

sld_arr(x, ...)

Arguments

x	An R object.
sss	A character scalar single basic property from link{sss_props}().
ccc	A character scalar single extended class property from link{ccc_props}()
...	Arguments passed on to meets

Functions

• sss_ccc(): Checks x for a combination of the single shape property sss and the single extended class property ccc subject to any count or value restrictions in .... Returns a logical scalar.

• sss_ccc_funs(): Lists all shape-plus-extended class combo property checking functions. Returns a character vector.

• sss_ccc_props(): Lists all shape-plus-extended class combo properties.

• emp_arr(): Checks x for empty-ness and array-ness. Returns a logical scalar.

• emp_dtf(): Checks x for empty-ness and data.frame-ness. Returns a logical scalar.

• emp_gen(): Checks x for empty-ness and generic-ness. Returns a logical scalar.

• emp_mat(): Checks x for empty-ness and matrix-ness. Returns a logical scalar.

• emp_vec(): Checks x for empty-ness and vec-ness. Returns a logical scalar.

• emp_vls(): Checks x for empty-ness and vector-list-ness. Returns a logical scalar.

• pnt_arr(): Checks x for point-ness and array-ness. Returns a logical scalar.

• pnt_dtf(): Checks x for point-ness and data.frame-ness. Returns a logical scalar.

• pnt_gen(): Checks x for point-ness and generic-ness. Returns a logical scalar.

• pnt_mat(): Checks x for point-ness and matrix-ness. Returns a logical scalar.

• pnt_scl(): Checks x for point-ness and scalar-ness. Returns a logical scalar.

• pnt_vec(): Checks x for point-ness and vec-ness. Returns a logical scalar.

• pnt_vls(): Checks x for point-ness and vector-list-ness. Returns a logical scalar.

• lin_arr(): Checks x for linear-ness and array-ness. Returns a logical scalar.

• lin_dtf(): Checks x for linear-ness and data.frame-ness. Returns a logical scalar.

• lin_gen(): Checks x for linear-ness and generic-ness. Returns a logical scalar.

• lin_mat(): Checks x for linear-ness and matrix-ness. Returns a logical scalar.

• lin_mvc(): Checks x for linear-ness and multivec-ness. Returns a logical scalar.

• lin_vec(): Checks x for linear-ness and vec-ness. Returns a logical scalar.

• lin_vls(): Checks x for linear-ness and vector-list-ness. Returns a logical scalar.

• col_dtf(): Checks x for column-ness and data.frame-ness. Returns a logical scalar.

• col_mat(): Checks x for column-ness and matrix-ness. Returns a logical scalar.

• row_dtf(): Checks x for row-ness and data.frame-ness. Returns a logical scalar.

• row_mat(): Checks x for row-ness and matrix-ness. Returns a logical scalar.

• rct_dtf(): Checks x for rectangle-ness and data.frame-ness. Returns a logical scalar.

• rct_mat(): Checks x for rectangle-ness and matrix-ness. Returns a logical scalar.

• sqr_mat(): Checks x for square-ness and matrix-ness. Returns a logical scalar.

• sld_arr(): Checks x for solid-ness and array-ness. 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(), iii_help(), meets(), mmm_ccc_help(), mmm_help(), ppp_fast_help(), ppp_help(), sss_prop_funs(), unq_ccc_prop_funs(), unq_mmm_ccc_help(), unq_mmm_help()

Examples

sss_ccc_funs()
sss_ccc(letters, "lin", "vec")
sss_ccc(1, "emp", "vec")
lin_gen(letters)
pnt_vec(1)

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