ppp_fast_help: Fast Property Checking for Common Checks with Optional valid...

In j-martineau/uj: Utilities by JAM

Fast Property Checking for Common Checks with Optional valid Values

Description

Fast property checking for ppp functions without the dot prefix (e.g., .ATM(x) is a faster version of ATM(x) because it uses only base functions to conduct property checking).

Usage

ppp_fast_help()

.ATM(x, valid = NULL)

.DEF(x, valid = NULL)

.FUN(x, valid = NULL)

.NIL(x)

.NLL(x)

.POP(x, valid = NULL)

.RCR(x)

.ARR(x, valid = NULL)

.DTF(x)

.GEN(x)

.MAT(x, valid = NULL)

.MVC(x, valid = NULL)

.SCL(x, valid = NULL)

.VLS(x)

.VEC(x, valid = NULL)

.D0D(x)

.D1D(x, valid = NULL)

.D2D(x, valid = NULL)

.DHD(x, valid = NULL)

.EUD(x)

.E2D(x, valid = NULL)

.EHD(x, valid = NULL)

.E0D(x, valid = NULL)

.E1D(x, valid = NULL)

.NA0(x)

.OK0(x, valid = NULL)

.DUP(x, valid = NULL)

.UNQ(x, valid = NULL)

.CMP(x, valid = NULL)

.MSS(x)

.PRT(x, valid = NULL)

.CH1(x, valid = NULL)

.CH3(x, valid = NULL)

.CHR(x, valid = NULL)

.STR(x, valid = NULL)

.CLR(x, valid = NULL)

.FAC(x, valid = NULL)

.ORD(x, valid = NULL)

.UNO(x, valid = NULL)

.IND(x, valid = NULL)

.NST(x, valid = NULL)

.SRT(x, valid = NULL)

.LGL(x, valid = NULL)

.NUM(x, valid = NULL)

.WHL(x, valid = NULL)

.ODD(x, valid = NULL)

.EVN(x, valid = NULL)

.NGW(x, valid = NULL)

.NPW(x, valid = NULL)

.POS(x, valid = NULL)

.PSW(x, valid = NULL)

.FRC(x, valid = NULL)

.NEG(x, valid = NULL)

.POS(x, valid = NULL)

.NNG(x, valid = NULL)

.NNW(x, valid = NULL)

.NPS(x, valid = NULL)

.PCT(x, valid = NULL)

.PPN(x, valid = NULL)

.COR(x, valid = NULL)

.COL(x, valid = NULL)

.ROW(x, valid = NULL)

.PNT(x, valid = NULL)

.SLD(x, valid = NULL)

.SQR(x, valid = NULL)

.EMP(x)

.RCT(x, valid = NULL)

.LIN(x, valid = NULL)

.atm_dtf(x, valid = NULL)

.atm_mat(x, valid = NULL)

.atm_scl(x, valid = NULL)

.atm_vec(x, valid = NULL)

.atm_vls(x, valid = NULL)

.chr_arr(x, valid = NULL)

.chr_dtf(x, valid = NULL)

.chr_vec(x, valid = NULL)

.chr_vls(x, valid = NULL)

.cmp_atm(x, valid = NULL)

.cmp_chr(x, valid = NULL)

.cmp_cor(x, valid = NULL)

.cmp_num(x, valid = NULL)

.cmp_scl(x, valid = NULL)

.cmp_vec(x, valid = NULL)

.lgl_scl(x, valid = NULL)

.nnw_vec(x, valid = NULL)

.pop_atm(x, valid = NULL)

.pop_chr(x, valid = NULL)

.pop_dtf(x, valid = NULL)

.pop_mat(x, valid = NULL)

.pop_srt(x, valid = NULL)

.pop_vec(x, valid = NULL)

.pop_vls(x, valid = NULL)

.cmp_atm_vec(x, valid = NULL)

.cmp_ch1_scl(x, valid = NULL)

.cmp_ch1_vec(x, valid = NULL)

.cmp_ch3_scl(x, valid = NULL)

.cmp_ch3_vec(x, valid = NULL)

.cmp_chr_arr(x, valid = NULL)

.cmp_chr_dtf(x, valid = NULL)

.cmp_chr_vec(x, valid = NULL)

.cmp_chr_vls(x, valid = NULL)

.cmp_cor_scl(x, valid = NULL)

.cmp_cor_vec(x, valid = NULL)

.cmp_cor_mvc(x, valid = NULL)

.cmp_cor_sqr(x, valid = NULL)

.cmp_chr_gen(x, valid = NULL)

.cmp_chr_scl(x, valid = NULL)

.cmp_clr_vec(x, valid = NULL)

.cmp_lgl_scl(x, valid = NULL)

.cmp_lgl_vec(x, valid = NULL)

.cmp_nng_scl(x, valid = NULL)

.cmp_nnw_scl(x, valid = NULL)

.cmp_nnw_vec(x, valid = NULL)

.cmp_num_scl(x, valid = NULL)

.cmp_num_vec(x, valid = NULL)

.cmp_pos_vec(x, valid = NULL)

.cmp_ppn_scl(x, valid = NULL)

.cmp_ppn_vec(x, valid = NULL)

.cmp_psw_scl(x, valid = NULL)

.cmp_psw_vec(x, valid = NULL)

.cmp_srt_vec(x, valid = NULL)

.cmp_str_scl(x, valid = NULL)

.cmp_str_vec(x, valid = NULL)

.cmp_whl_scl(x, valid = NULL)

.cmp_atm_mvc(x, valid = NULL)

.unq_atm_mvc(x, valid = NULL)

.unq_atm_vec(x, valid = NULL)

.unq_ch1_vec(x, valid = NULL)

.unq_ch3_vec(x, valid = NULL)

.unq_chr_vec(x, valid = NULL)

.unq_nnw_vec(x, valid = NULL)

.unq_num_vec(x, valid = NULL)

.unq_psw_vec(x, valid = NULL)

.unq_str_vec(x, valid = NULL)

.atm_rct_dtf(x, valid = NULL)

.atmrctdtf(x)

Arguments

x	Any object. See details.
valid	An optional object containing valid atomic values to check against atomic values in x. See details.

Details

When valid is supplied, both x and valid are atomized before checking whether all atomic elements of x are contained in the atomic elements of valid.

Value

A logical scalar.

Functions

• .ATM(): Checks for atomic-ness subject to any value restrictions in valid.

• .DEF(): Checks for defined-ness (non-NULL-ness) subject to any value restrictions in valid.

• .FUN(): Checks for function-ness (function object or function name) subject to any value restrictions in valid.

• .NIL(): Checks for nil-ness (length 0-ness).

• .NLL(): Checks for NULL-ness.

• .POP(): Checks for populated-ness subject to any value restrictions in valid.

• .RCR(): Checks for recursiveness.

• .ARR(): Checks for array-ness subject to any value restrictions in valid.

• .DTF(): Checks for data.frame-ness subject to any value restrictions in valid.

• .GEN(): Checks for generic-ness (array-ness or vector-ness).

• .MAT(): Checks for matrix-ness subject to any value restrictions in valid.

• .MVC(): Checks for multivec-ness subject to any value restrictions in valid.

• .SCL(): Checks for scalar-ness subject to any value restrictions in valid.

• .VLS(): Checks for vector-list-ness.

• .VEC(): Checks for vec-ness (scalar or vector) subject to any value restrictions in valid.

• .D0D(): Checks for zero defined dimensions.

• .D1D(): Checks for a single defined dimension subject to any value restrictions in valid.

• .D2D(): Checks for two defined dimensions subject to any value restrictions in valid.

• .DHD(): Checks for hyper-defined dimension-ness subject to any value restrictions in valid.

• .EUD(): Checks for undefined effective dimensionality.

• .E2D(): Checks for effective bi-dimensionality subject to any value restrictions in valid.

• .EHD(): Checks for effective hyper-dimensionality subject to any value restrictions in valid.

• .E0D(): Checks for effective zero-dimensionality subject to any value restrictions in valid.

• .E1D(): Checks for effective unidimensionality subject to any value restrictions in valid.

• .NA0(): Checks for scalar NA-ness.

• .OK0(): Checks for atomic, non-NA scalar-ness subject to any value restrictions in valid.

• .DUP(): Checks for atomic duplicated-ness subject to any value restrictions in valid.

• .UNQ(): Checks for atomic uniqueness subject to any value restrictions in valid.

• .CMP(): Checks for atomic completeness (non-NA-ness) subject to any value restrictions in valid.

• .MSS(): Checks for atomic fully-missing-ness.

• .PRT(): Checks for atomic partial completeness subject to any value restrictions in valid.

• .CH1(): Checks for atomic one-char-ness subject to any value restrictions in valid.

• .CH3(): Checks for atomic three-char-ness subject to any value restrictions in valid.

• .CHR(): Checks for atomic character-ness subject to any value restrictions in valid.

• .STR(): Checks for atomic string-ness (non-blank and character) subject to any value restrictions in valid.

• .CLR(): Checks for atomic color-ness subject to any value restrictions in valid.

• .FAC(): Checks for factor-ness subject to any value restrictions in valid.

• .ORD(): Checks for ordered factor-ness subject to any value restrictions in valid.

• .UNO(): Checks for unordered factor-ness subject to any value restrictions in valid.

• .IND(): Checks for indexer-ness (positive whole number or logical) subject to any value restrictions in valid.

• .NST(): Checks for non-sortableness subject to any value restrictions in valid.

• .SRT(): Checks for sortable-ness subject to any value restrictions in valid.

• .LGL(): Checks for logical-ness subject to any value restrictions in valid.

• .NUM(): Checks for numeric-ness subject to any value restrictions in valid.

• .WHL(): Checks for whole-number-ness subject to any value restrictions in valid.

• .ODD(): Checks for odd-valued-ness subject to any value restrictions in valid.

• .EVN(): Checks for even-valued-ness subject to any value restrictions in valid.

• .NGW(): Checks for negative whole-numbered-ness subject to any value restrictions in valid.

• .NPW(): Checks for non-positive whole-numbered-ness subject to any value restrictions in valid.

• .POS(): Checks for positive numeric-ness subject to any value restrictions in valid.

• .PSW(): Checks for positive whole-numbered-ness subject to any value restrictions in valid.

• .FRC(): Checks for numeric fractional-ness subject to any value restrictions in valid.

• .NEG(): Checks for negative numeric-ness subject to any value restrictions in valid.

• .POS(): Checks for positive numeric-ness subject to any value restrictions in valid.

• .NNG(): Checks for non-negative numeric-ness subject to any value restrictions in valid.

• .NNW(): Checks for non-negative whole-numbered-ness subject to any value restrictions in valid.

• .NPS(): Checks for non-positive numeric-ness subject to any value restrictions in valid.

• .PCT(): Checks for percentage-valued-ness subject to any value restrictions in valid.

• .PPN(): Checks for proportion-valued-ness subject to any value restrictions in valid.

• .COR(): Checks for correlation-valued-ness subjec to any value restrictions in valid.

• .COL(): Checks for column-ness subject to any value restrictions in valid.

• .ROW(): Checks for row-ness subject to any value restrictions in valid.

• .PNT(): Checks for point-ness subject to any value restrictions in valid.

• .SLD(): Checks for solid-ness subject to any value restrictions in valid.

• .SQR(): Checks for square matrix-ness subject to any value restrictions in valid.

• .EMP(): Checks for emptiness (length 0 but not NULL).

• .RCT(): Checks for rectangularness (nrow > 1 and ncol > 1) subject to any value restrictions in valid.

• .LIN(): Checks for linearness subject to any value restrictions in valid.

• .atm_dtf(): Checks for atomic data.frame-ness subject to any value restrictions in valid.

• .atm_mat(): Checks for atomic matrix-ness subject to any value restrictions in valid.

• .atm_scl(): Checks for atomic scalar-ness subject to any value restrictions in valid.

• .atm_vec(): Checks for atomic vec-ness subject to any value restrictions in valid.

• .atm_vls(): Checks for atomic vector-list-ness subject to any value restrictions in valid.

• .chr_arr(): Checks for character array-ness subject to any value restrictions in valid.

• .chr_dtf(): Checks for character data.frame-ness subject to any value restrictions in valid.

• .chr_vec(): Checks for character vec-ness subject to any value restrictions in valid.

• .chr_vls(): Checks for character vector-list-ness subject to any value restrictions in valid.

• .cmp_atm(): Checks for atomic completeness subject to any value restrictions in valid.

• .cmp_chr(): Checks for character completeness subject to any value restrictions in valid.

• .cmp_cor(): Checks for correlation-valued completeness subject to any value restrictions in valid.

• .cmp_num(): Checks for numeric completeness subject to any value restrictions in valid.

• .cmp_scl(): Checks for scalar completeness subject to any value restrictions in valid.

• .cmp_vec(): Checks for vec completeness subject to any value restrictions in valid.

• .lgl_scl(): Checks for logical scalar-ness subject to any value restrictions in valid.

• .nnw_vec(): Checks for non-negative whole-numbered vec-ness subject to any value restrictions in valid.

• .pop_atm(): Checks for populated atomic-ness subject to any value restrictions in valid.

• .pop_chr(): Checks for populated character-ness subject to any value restrictions in valid.

• .pop_dtf(): Checks for populated data.frame-ness subject to any value restrictions in valid.

• .pop_mat(): Checks for populated matrix-ness subject to any value restrictions in valid.

• .pop_srt(): Checks for populated sortableness subject to any value restrictions in valid.

• .pop_vec(): Checks for populated vec-ness subject to any value restrictions in valid.

• .pop_vls(): Checks for populated vector-list-ness subject to any value restrictions in valid.

• .cmp_atm_vec(): Checks for atomic vector completeness subject to any value restrictions in valid.

• .cmp_ch1_scl(): Checks for one-char scalar completeness subject to any value restrictions in valid.

• .cmp_ch1_vec(): Checks for one-char vec completeness subject to any value restrictions in valid.

• .cmp_ch3_scl(): Checks for three-char scalar completeness subject to any value restrictions in valid.

• .cmp_ch3_vec(): Checks for three-char vec completeness subject to any value restrictions in valid.

• .cmp_chr_arr(): Checks for character array completeness subject to any value restrictions in valid.

• .cmp_chr_dtf(): Checks for character data-frame completeness subject to any value restrictions in valid.

• .cmp_chr_vec(): Checks for character vec completeness subject to any value restrictions in valid.

• .cmp_chr_vls(): Checks for character vector-list completeness subject to any value restrictions in valid.

• .cmp_cor_scl(): Checks for correlation-valued scalar completeness subject to any value restrictions in valid.

• .cmp_cor_vec(): Checks for correlation-valued vec completeness subject to any value restrictions in valid.

• .cmp_cor_mvc(): Checks for correlation-valued multivec completeness subject to any value restrictions in valid.

• .cmp_cor_sqr(): Checks for correlation-valued square matrix completeness subject to any value restrictions in valid.

• .cmp_chr_gen(): Checks for character generic completeness subject to any value restrictions in valid.

• .cmp_chr_scl(): Checks for character scalar completeness subject to any value restrictions in valid.

• .cmp_clr_vec(): Checks for color vec completeness subject to any value restrictions in valid.

• .cmp_lgl_scl(): Checks for logical scalar completeness subject to any value restrictions in valid.

• .cmp_lgl_vec(): Checks for logical vec completeness subject to any value restrictions in valid.

• .cmp_nng_scl(): Checks for non-negative numeric scalar completeness subject to any value restrictions in valid.

• .cmp_nnw_scl(): Checks for non-negative whole-numbered scalar completeness subject to any value restrictions in valid.

• .cmp_nnw_vec(): Checks for non-negative whole-numbered vec completeness subject to any value restrictions in valid.

• .cmp_num_scl(): Checks for numeric scalar completeness subject to any value restrictions in valid.

• .cmp_num_vec(): Checks for numeric vec completeness subject to any value restrictions in valid.

• .cmp_pos_vec(): Checks for positive numeric vec completeness subject to any value restrictions in valid.

• .cmp_ppn_scl(): Checks for proportion-valued scalar completeness subject to any value restrictions in valid.

• .cmp_ppn_vec(): Checks for proportion-value vec completeness subject to any value restrictions in valid.

• .cmp_psw_scl(): Checks for positive whole-numbered scalar completeness subject to any value restrictions in valid.

• .cmp_psw_vec(): Checks for positive whole-numbered vec completeness subject to any value restrictions in valid.

• .cmp_srt_vec(): Checks for sortable vec completeness subject to any value restrictions in valid.

• .cmp_str_scl(): Checks for string scalar completeness subject to any value restrictions in valid.

• .cmp_str_vec(): Checks for string vec completeness subject to any value restrictions in valid.

• .cmp_whl_scl(): Checks for whole-numbered scalar completeness subject to any value restrictions in valid.

• .cmp_atm_mvc(): Checks for atomic multivec completeness subject to any value restrictions in valid.

• .unq_atm_mvc(): Checks for atomic multivec non-NA uniqueness subject to any value restrictions in valid.

• .unq_atm_vec(): Checks for atomic vec non-NA uniqueness subject to any value restrictions in valid.

• .unq_ch1_vec(): Checks for one-char vec non-NA uniqueness subject to any value restrictions in valid.

• .unq_ch3_vec(): Checks for three-char vec non-NA uniqueness subject to any value restrictions in valid.

• .unq_chr_vec(): Checks for character vec non-NA uniqueness subject to any value restrictions in valid.

• .unq_nnw_vec(): Checks for non-negative whole-numbered non-NA uniqueness subject to any value restrictions in valid.

• .unq_num_vec(): Checks for numeric vec non-NA uniqueness subject to any value restrictions in valid.

• .unq_psw_vec(): Checks for positive whole-numbered vec non-NA uniqueness subject to any value restrictions in valid.

• .unq_str_vec(): Checks for string vec non-NA uniqueness subject to any value restrictions in valid.

• .atm_rct_dtf(): Checks for atomic rectangular data-frame-ness subject to any value restrictions in valid.

• .atmrctdtf(): Super-fast check of whether an object is a data frame that has 2+ rows, has 2+ columns, and contains only atomic elements.

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_help(), sss_ccc_help(), sss_prop_funs(), unq_ccc_prop_funs(), unq_mmm_ccc_help(), unq_mmm_help()

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