bbb_ccc_help: Combo Basic Plus Extended Class Properties

View source: R/bbb_ccc.R

bbb_ccc_helpR Documentation

Combo Basic Plus Extended Class Properties

Description

Some combinations of basic + extended class properties are nonsensical. For this reason, the basic properties represented in this family of functions are c('atm', 'nil', 'pop'), or atomic, nil (non-NULL and of length 0), and populated (of length ⁠1+⁠).

In addition, the base property 'nil' is nonsensical in combination with extended classes 'mvc' (multivec) and 'scl' (scalar), which thus do not have combined bbb_ccc property functions.

Usage

bbb_ccc_help()

bbb_ccc(x, bbb, ccc, ...)

bbb_ccc_funs()

bbb_ccc_funs()

atm_arr(x, ...)

atm_dtf(x, ...)

atm_gen(x, ...)

atm_mat(x, ...)

atm_mvc(x, ...)

atm_scl(x, ...)

atm_vec(x, ...)

atm_vls(x, ...)

nil_arr(x, ...)

nil_dtf(x, ...)

nil_gen(x, ...)

nil_mat(x, ...)

nil_vec(x, ...)

nil_vls(x, ...)

pop_arr(x, ...)

pop_dtf(x, ...)

pop_gen(x, ...)

pop_mat(x, ...)

pop_mvc(x, ...)

pop_scl(x, ...)

pop_vec(x, ...)

pop_vls(x, ...)

Arguments

x

An R object.

bbb

A character scalar single basic property from bbb_props().

ccc

A character scalar single extendec class property from ccc_props().

...

Arguments passed on to meets

Functions

  • bbb_ccc(): Checks x for the basic property in bbb and for the extended class property in ccc subject to any count and/or value restrictions in .... Returns a logical scalar.

  • bbb_ccc_funs(): Lists all combo basic plus extended class property checking functions.

  • bbb_ccc_funs(): Lists all combo basic plus extended class properties.

  • atm_arr(): Checks x for atomic-ness and array-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • atm_dtf(): Checks x for atomic-ness and data.frame-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • atm_gen(): Checks x for atomic-ness and generic-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • atm_mat(): Checks x for atomic-ness and matrix-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • atm_mvc(): Checks x for atomic-ness and multivec-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • atm_scl(): Checks x for atomic-ness and scalar-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • atm_vec(): Checks x for atomic-ness and vec-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • atm_vls(): Checks x for atomic-ness and vector-list-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • nil_arr(): Checks x for nil-ness and array-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • nil_dtf(): Checks x for nil-ness and data.frame-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • nil_gen(): Checks x for nil-ness and generic-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • nil_mat(): Checks x for nil-ness and matrix-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • nil_vec(): Checks x for nil-ness and vec-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • nil_vls(): Checks x for nil-ness and vector-list-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • pop_arr(): Checks x for populated-ness and array-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • pop_dtf(): Checks x for populated-ness and data.frame-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • pop_gen(): Checks x for populated-ness and generic-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • pop_mat(): Checks x for populated-ness and matrix-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • pop_mvc(): Checks x for populated-ness and multivec-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • pop_scl(): Checks x for populated-ness and scalar-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • pop_vec(): Checks x for populated-ness and vec-ness subject to any count and/or value restrictions in .... Returns a logical scalar.

  • pop_vls(): Checks x for populated-ness and vector-list-ness subject to any count and/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_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_ccc_help(), sss_prop_funs(), unq_ccc_prop_funs(), unq_mmm_ccc_help(), unq_mmm_help()

Examples

bbb_ccc_funs()
bbb_ccc(letters, "atm", "mvc")
bbb_ccc(1, "nil", "vec")
atm_gen(letters)
atm_scl(1)

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