is.avector {str2str}

Test for an Atomic Vector

Description

is.avector returns whether an object is an atomic vector with typeof character, logical, integer, or double.

Usage

is.avector(x, attr.ok = TRUE, fct.ok = TRUE)

Arguments

x

object whose structure is desired to be tested.

attr.ok

logical vector with length 1 specifying whether non-core attributes are allowed in x. Core attributes are 1) "names", 2) "dim", 3) "dimnames", 4) "levels", and 5) "class". Therefore, attr.ok refers to attributes *other* than these 5.

fct.ok

logical vector with length 1 specifying whether factors are allowed.

Details

is.avector is simply a logical "and" of is.atomic and is.vector.

Value

logical vector with length 1 specifying whether x is an atomic vector. If attr.ok is TRUE then non-core attributes are allowed (e.g., "value.labels"). If fct.ok is TRUE then factors are allowed.

Examples

# normal use
is.avector(x = c(1,2,3))
is.avector(x = c("one" = 1, "two" = 2, "three" = 3)) # names are always okay
is.avector(x = array(c(1,2,3))) # returns false for arrays
is.avector(x = list(1,2,3)) # returns false for lists

# non-core attributes
x <- structure(.Data = c(1,2,3), "names" = c("one","two","three"),
   "value.labels" = c("woman","man","non-binary"))
attributes(x)
is.avector(x)
is.avector(x, attr.ok = FALSE)

# factors
x <- factor(c(1,2,3), labels = c("one","two","three"))
is.avector(x)
is.avector(x, fct.ok = FALSE)