aliases: Internal Utilities These utilities are used internally and...

In Rd: Rd Manipulation and Creation

Description

Internal Utilities

These utilities are used internally and not exported. They are however documented for completeness

Usage

s(x, ...)

cl(x, new)

undim(x)

named(...)

clean_Rd(obj, ...)

get_attr(x, which, default = NULL, exact = TRUE)

forward_attributes(x, obj)

fwd(x, obj)

is_whitespace(x)

Arguments

x, obj	An object, any object.
...	passed on to other function(s).
new	the new class(es) to append.
which	name of the attribute to extract.
default	the default value to return if not found.
exact	exact or partial matching?

Functions

• s: Alias for structure, but also adds automatic naming when unnamed,

• cl: Specify an additional class for an object, or class when none is set.

• undim: Remove the dim attribute.

• named: Create a named list with names inferred if needed.

• clean_Rd: Alias for tools::toRd.default()

• get_attr: Alias for attr(x, which) %||% default.

• forward_attributes: Forward attributes from object to value.

• fwd: Alias for forward_attributes().

• is_whitespace: Check if a string is composed of only whitespace, with regex pattern "^\s+$".

See Also

purrr::%||%()

base::attributes()

Rd documentation built on May 23, 2019, 9:03 a.m.