naming_help: Naming utilities
In j-martineau/uj: Utilities by JAM

naming_help

R Documentation

Naming utilities

Description

Get object names (with optional restrictions), check whether names exist (with optional restrictions), and apply names.

Usage

naming_help()

name_vals(x, vn)

name_vs(x, vn)

name_elts(x, en)

name_es(x, en)

name_rows(x, rn)

name_rs(x, rn)

name_cols(x, cn)

name_cs(x, cn)

name_scl_vls(x, en)

name_sv(x, en)

name_rows_cols(x, rn, cn)

name_rcs(x, rn, cn)

name(x, en = NULL, vn = NULL, rn = NULL, cn = NULL)

named(x, d = 0, u = T, bl = F)

named_elts(x, u = T, bl = F)

elts_named(x, u = T, bl = F)

named_es(x, u = T, bl = F)

es_named(x, u = T, bl = F)

named_vals(x, u = T, bl = F)

vals_named(x, u = T, bl = F)

named_vs(x, u = T, bl = F)

vs_named(x, u = T, bl = F)

named_rows(x, u = T, bl = F)

rows_named(x, u = T, bl = F)

named_rs(x, u = T, bl = F)

rs_named(x, u = T, bl = F)

named_cols(x, u = T, bl = F)

cols_named(x, u = T, bl = F)

named_cs(x, u = T, bl = F)

cs_named(x, u = T, bl = F)

named_rows_cols(x, u = T, bl = F)

rows_cols_named(x, u = T, bl = F)

named_rcs(x, u = T, bl = F)

rcs_named(x, u = T, bl = F)

all_dots_named(...)

get_names(x, d = 0, u = T, err = F)

enames(x, u = T, err = F)

en()

vnames()

vn()

rnames(x, u = T, err = F)

rn(x, do.NULL = TRUE, prefix = "row")

cnames(x, u = T, err = F)

cn(x, do.NULL = TRUE, prefix = "col")

row_col_names(x, u = T, err = F)

rcnames(x, u = T, err = F)

rcn(x, u = T, err = F)

Arguments

`x`	Vector or list for `name_vals`/`name_elts` and `val_names / elt_names / vn / en`; matrix or data.frame for `rnames / rn`, `cnames / cn`, `rcnames / rcn`, `name_rcs`, `name_cols`, and `name_rows`; or any object for `name_scl_vls`.
`en`, `vn`, `rn`, `cn`	A complete character vec element, value, row, and column named, respectively.
`d`	A complete positive whole-number scalar giving the dimension(s) to name: `0` for elements (of atomic or list vectors only), `1` for rows of matrices or tibbles, `2` for columns of matrices or data.frames, or `12` for rows and columns of matrices or data.frames.
`u`	`TRUE` or `FALSE` indicating whether names and `...` argument names must be unique, respectively.
`bl`	`TRUE` or `FALSE` indicating whether blank strings (`""`) are allowed as names and `...` argument names, respectively.
`...`	An arbitrary number of arguments.
`err`	`TRUE` or `FALSE` indicating whether names and `...` argument names must exist, respectively.
`name`	A non-`NA` character scalar to name the single element of the resulting vlist.

Functions

name_vals(): Named the values/elements of x as vn. Returns x with names applied.
name_vs(): An alias for name_vals.
name_elts(): Name the values/elements of x as en
name_es(): An alias for name_elts.
name_rows(): Name the rows of x as rn. Returns x with row names applied.
name_rs(): An alias for name_rows.
name_cols(): Name the columns of x as cn. Returns x with column names applied.
name_cs(): An alias for name_cols.
name_scl_vls(): Store x in a single-element list and name that element en. Returns a named, single-element list.
name_sv(): An alias for name_scl_vls.
name_rows_cols(): Name the rows of x as rn and the columns of x as cn. Returns x with row and column names applied.
name_rcs(): An alias for name_rows_cols.
name(): Name the values/elements of, rows of, and/or columns of x. Returns x with specified names applied.
named(): Evaluates whether elements/rows/columns/drawers/... of x are named, optionally checking for uniqueness and non-blankness. Returns a logical scalar or throws an error.
named_elts(): Evaluates whether elements/values of x are named, optionally checking for uniqueness and non-blankness. Returns a logical scalar or throws an error.
elts_named(): An alias for named_elts.
named_es(): An alias for named_elts.
es_named(): An alias for named_elts.
named_vals(): An alias for named_elts.
vals_named(): An alias for named_elts.
named_vs(): An alias for named_elts.
vs_named(): An alias for named_elts.
named_rows(): Evaluates whether rows of x are named, optionally checking for uniqueness and non-blankness. Returns a logical scalar or throws an error.
rows_named(): An alias for named_rows.
named_rs(): An alias for named_rows.
rs_named(): An alias for named_rows.
named_cols(): Evaluates whether columns of x are named, optionally checking for uniqueness and non-blankness. Returns a logical scalar or throws an error.
cols_named(): An alias for named_cols.
named_cs(): An alias for named_cols.
cs_named(): An alias for named_cols.
named_rows_cols(): Evaluates whether rows and columns of x are named, optionally checking for uniqueness and non-blankness. Returns a logical scalar or throws an error.
rows_cols_named(): An alias for named_rows_cols.
named_rcs(): An alias for named_rows_cols.
rcs_named(): An alias for named_rows_cols.
all_dots_named(): Evaluates whether all ... arguments are named. Returns a logical scalar or throws an error.
get_names(): Generalized name retrieval (elements/values/rows/cols/drawers/...), optionally checking for uniqueness. Returns either a character vector of a list of two character vectors, or throws an error.
enames(): Gets names of the elements/values of x, optionally checking for uniqueness. Returns a character vector or throws an error.
en(): An alias for enames.
vnames(): An alias for enames.
vn(): An alias for enames.
rnames(): Gets names of the rows of x, optionally checking for uniqueness. Returns a character vector or throws an error.
rn(): An alias for rnames.
cnames(): Gets names of the columns of x, optionally checking for uniqueness. Returns a character vector or throws an error.
cn(): An alias for cnames.
row_col_names(): Gets names of the rows and columns of x, optionally checking for uniqueness. Returns a character vector or throws an error.
rcnames(): An alias for row_col_names.
rcn(): An alias for row_col_names.

Examples

egDotsNamed <- function(...) {dnamed(...)}

egVec <- 1:5
egVls <- list(num = 1:5, ae = letters[1:5])
egMat <- matrix(letters[1:25], nrow = 5)
egDtf <- data.frame(ae = letters[1:5], AE = LETTERS[1:5])

egVec
egVls
egMat
egDtf

named(egVec)
named(egVls)
named(egMat, d = 12)
named(egDtf, d = 2)

vals_are_named(egVls)
rows_are_named(egMat)
cols_are_named(egDtf)
rcs_are_named(egDtf)

dots_are_named(egVec, egVls)
dots_are_named(var1 = egVec, var2 = egVls)

get_names(egVls)
get_names(egMat, d = 1)
get_names(egDtf, d = 2)

en(egVec)
en(egVls)

rn(egMat)
cn(egDtf)
rcn(egDtf)

name_scl_vls(egDtf, "a data.frame")
name_vals(egVec, letters[egVec])
name_rows(egMat, letters[egVec])
name_cols(egDtf, c("letters", "LETTERS"))
name_rcs(egMat, letters[egVec], egVec)

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