element_vec: Apply a function to the fields of an element object

View source: R/ggplot-helper.R

element_vecR Documentation

Apply a function to the fields of an element object

Description

For an element object, some fields are vectorized, while others are not. This function allows you to apply a function to the vectorized fields.

The following helper functions are available:

  • element_rep: Applies rep().

  • element_rep_len: Applies rep_len().

  • element_vec_recycle: Applies vec_recycle().

  • element_vec_rep: Applies vec_rep().

  • element_vec_rep_each: Applies vec_rep_each().

  • element_vec_slice: Applies vec_slice().

Usage

element_vec(.el, .fn, ...)

element_rep(.el, ...)

element_rep_len(.el, length.out, ...)

element_vec_recycle(.el, size, ...)

element_vec_rep(.el, times, ...)

element_vec_rep_each(.el, times, ...)

element_vec_slice(.el, i, ...)

Arguments

.el

An element object.

.fn

The function to be applied to the vectorized fields of the element object.

...

Additional arguments passed on to fn.

length.out

Non-negative integer. The desired length of the output vector. Other inputs will be coerced to a double vector and the first element taken. Ignored if NA or invalid.

size

Desired output size.

times

For vec_rep(), a single integer for the number of times to repeat the entire vector.

For vec_rep_each(), an integer vector of the number of times to repeat each element of x. times will be recycled to the size of x.

i

An integer, character or logical vector specifying the locations or names of the observations to get/set. Specify TRUE to index all elements (as in x[]), or NULL, FALSE or integer() to index none (as in x[NULL]).


ggalign documentation built on June 8, 2025, 11:25 a.m.