values_help: Named values (unique to package 'uj')

In j-martineau/uj: Utilities by JAM

Named values (unique to package uj)

Description

Get names, definitions, and values of special uj package named values.

Usage

values_help()

values(vec = FALSE)

value_names()

value_descriptions()

value_table()

value(...)

vals(vec = FALSE)

val_names()

val_table()

val(...)

vs(vec = FALSE)

vnames()

vtable()

v(...)

Arguments

vec	Logical scalar indicating whether to collapse multi-element values of the result using a pipe (|) delimiter.
...	Unquoted, comma-separated list of names of values to return. If multiple values are specified, they are coerced into a single atomic vector result.

Details

⁠value_names, val_names, vnames⁠	Get names of all package values.
⁠value_table, val_table, vtable⁠	Get a data.frame of all uj-specific named values with three columns: name, value, and description, where named values with multiple elements are pipe-delimited and all values are converted to mode character.
⁠values, values, vs⁠	Get a named list where names are the arguments submitted to v(...), element values are the values of the contents of the named element, and the attribute 'descriptions' gives associated verbose descriptions.
⁠value, val, v⁠	Gets package values by name.

Value

A character vector

⁠value_names, val_names, vnames⁠

A data.frame

⁠value_table, val_table, vtable⁠

A vlist

⁠values, values, vs⁠

An atomic scalar or vector

⁠value, val, v⁠

Functions

• values(): Gets package values by name

• value_names(): Get names of all uj package constant values. Returns a character scalar.

• value_descriptions(): Get plain language descriptions of uj package constant values. Returns a character scalar.

• value_table(): Builds a table of uj package constants and plain language descriptions.

• value(): Gets a single package uj constant value.

• vals(): An alias for values.

• val_names(): An alias for value_names.

• val_table(): An alias for value_table.

• val(): An alias for value.

• vs(): An alias for values

• vnames(): An alias for value_names

• vtable(): An alias for value_table

• v(): An alias for value

Examples

egValues <- function() {

  print(uj::v(.))
  print(uj::v(pipe, pipe1, eq))
  print(uj::vnames())
  print(uj::values())
  print(uj::vtable())

}

egValues()

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