norm_type: Argument checking

In teunbrand/tornadoplot: Tornado Plot

Description

These functions are for checking that arguments of parent functions are as expected.

Usage

norm_type_or_null(
  x,
  type,
  length = 1,
  allow_NAs = FALSE,
  arg = deparse(substitute(x))
)

norm_type(x, type, length = 1, allow_NAs = FALSE, arg = deparse(substitute(x)))

## S4 method for signature 'ANY,numeric'
norm_type(x, type, length = 1, allow_NAs = FALSE, arg = deparse(substitute(x)))

## S4 method for signature 'ANY,integer'
norm_type(x, type, length = 1, allow_NAs = FALSE, arg = deparse(substitute(x)))

Arguments

x	An argument to check.
type	A vector of the expected type, typically of length 0.
length	An integer(1) or NULL for the expected length. When set to NULL, length can be anything.
allow_NAs	A logical(1), when TRUE, allows the x argument to have NAs. If FALSE, raises error when x contains NAs.
arg	A character(1) for the argument being checked. This is used to identify the argument in error messaging. Defaults to the symbol used for x.

Value

It returns x if it satisfies the criteria, or x coerced to the type class when appropriate.

Examples

# Rounding of `numeric` to `integer`
norm_type(1.26, integer())

teunbrand/tornadoplot documentation built on Dec. 23, 2021, 8:48 a.m.