.coerce-params {stbl}R Documentation

Shared parameters

Description

These parameters are used in multiple coercion functions. They are defined here to make them easier to import and to find.

Arguments

...

These dots are for future extensions and should be empty.

allow_na

Logical. Are NA values ok?

allow_null

Logical. Is NULL an acceptable value?

allow_zero_length

Logical. Are zero-length vectors acceptable?

min_size

Integer. The minimum size of the object. Object size will be tested using vctrs::vec_size().

max_size

Integer. The maximum size of the object. Object size will be tested using vctrs::vec_size().

x

The argument to stabilize.

x_arg

Character. An argument name for x. The automatic value will work in most cases, or pass it through from higher-level functions to make error messages clearer in unexported functions.

x_class

Character. The class name of x to use in error messages. Use this if you remove a special class from x before checking its coercion, but want the error message to match the original class.

call

The execution environment of the call. See the call argument of rlang::abort() for more information.


[Package stbl version 0.1.1 Index]