Skip to contents

Check if an object can be safely coerced to double

Source: R/are_dbl_ish.R
are_dbl_ish.Rd

are_dbl_ish() is a vectorized predicate function that checks whether each element of its input can be safely coerced to a double vector.

is_dbl_ish() is a scalar predicate function that checks if all elements of its input can be safely coerced to a double vector.

Usage

are_dbl_ish(x, ...)

is_dbl_ish(x, ...)

# S3 method for class 'character'
are_dbl_ish(x, ..., coerce_character = TRUE)

# S3 method for class 'factor'
are_dbl_ish(x, ..., coerce_factor = TRUE)

# Default S3 method
are_dbl_ish(x, ..., depth = 1)

Arguments

x

The object to check.

...

Arguments passed to methods.

coerce_character

(length-1 logical) Should character vectors such as "1" and "2.0" be considered numeric-ish?

coerce_factor

(length-1 logical) Should factors with values such as "1" and "2.0" be considered numeric-ish? Note that this package uses the character value from the factor, while as.integer() and as.double() use the integer index of the factor.

depth

(length-1 integer) Current recursion depth. Do not manually set this parameter.

Value

are_dbl_ish() returns a logical vector with the same length as the input. is_dbl_ish() returns a length-1 logical (TRUE or FALSE) for the entire vector.

Examples

are_dbl_ish(c(1.0, 2.2, 3.14))
#> [1] TRUE TRUE TRUE
is_dbl_ish(c(1.0, 2.2, 3.14))
#> [1] TRUE

are_dbl_ish(1:3)
#> [1] TRUE TRUE TRUE
is_dbl_ish(1:3)
#> [1] TRUE

are_dbl_ish(c("1.1", "2.2", NA))
#> [1] TRUE TRUE TRUE
is_dbl_ish(c("1.1", "2.2", NA))
#> [1] TRUE

are_dbl_ish(c("a", "1.0"))
#> [1] FALSE  TRUE
is_dbl_ish(c("a", "1.0"))
#> [1] FALSE

are_dbl_ish(list(1, "2.2", "c"))
#> [1]  TRUE  TRUE FALSE
is_dbl_ish(list(1, "2.2", "c"))
#> [1] FALSE

are_dbl_ish(c(1 + 1i, 1 + 0i, NA))
#> [1] FALSE  TRUE  TRUE
is_dbl_ish(c(1 + 1i, 1 + 0i, NA))
#> [1] FALSE