Skip to contents

Return English-friendly messaging for object-types

Source: R/compat_friendly_type.R
friendly_type_of.Rd

[Deprecated]

This function is deprecated, please use cli functionality instead.

Usage

friendly_type_of(x, value = TRUE, length = FALSE)

Arguments

x

Any R object.

Default value

none

value

Whether to describe the value of x.

Default value

TRUE

length

Whether to mention the length of vectors and lists.

Default value

FALSE

Value

A string describing the type. Starts with an indefinite article, e.g. "an integer vector".

Details

This helper function aids us in forming user-friendly messages that gets called through what_is_it(), which is often used in the assertion functions to identify what object-type the user passed through an argument instead of an expected-type.

See also

Other deprecated: %or%(), arg_name(), enumerate(), valid_time_units(), what_is_it()