hidden: A Package For Detecting Hidden Types

#' Test for hidden data types
#'
#' Returns \code{TRUE} if the relevant hidden type (in the wide sense) is detected in the object.
#' The parameter \code{obvious} is used to return \code{FALSE} when the input is already of the searched type.
#'
#' @param x An object.
#' @param ... arguments passed to methods
#' @param na.values A vector of values to be ignored in \code{hide_num}, \code{hide_int}, and \code{hide_lgl}.
#' @param obvious A logical (default: FALSE).
#'
#' @return A logical.
#' @export
#'
#' @examples
# ## hides_num
# hides_num(c("1","2",NA))     # TRUE
# hides_num(c("1.5","2",NA))   # TRUE
# hides_num(factor(c(1,2,NA))) # TRUE
# hides_num(c(1, 2, NA))       # FALSE
# hides_num(c(1.5, 2, NA))     # FALSE
# hides_num(c(1L, 2L, NA))     # FALSE
# hides_num(c(1, 2, NA),   obvious = TRUE) # TRUE
# hides_num(c(1.5 , 2, NA),obvious = TRUE) # TRUE
# hides_num(c(1L,2L,NA),   obvious = TRUE) # TRUE
#
# ## hides_int
# hides_int(c("1","2",NA))         # TRUE
# hides_int(c("1","2","a",NA),"a") # TRUE
# hides_int(c("1.5","2",NA))       # FALSE
# hides_int(factor(c(1,2,NA)))     # TRUE
# hides_int(c(1, 2, NA))           # TRUE
# hides_int(c(1.5, 2, NA))         # FALSE
# hides_int(c(1L, 2L, NA))         # FALSE
# hides_int(c(1, 2, NA),   obvious = TRUE) # TRUE
# hides_int(c(1.5 , 2, NA),obvious = TRUE) # FALSE
# hides_int(c(1L,2L,NA),   obvious = TRUE) # FALSE
#
# ## hides_lgl
# hides_lgl(c("yes","no","yes",NA))              # TRUE
# hides_lgl(c("yes","no","yes","maybe"))         # FALSE
# hides_lgl(c("yes","no","yes","maybe"),"maybe") # TRUE
# hides_lgl(factor(c("yes","no","yes",NA)))              # TRUE
# hides_lgl(factor(c("yes","no","yes","maybe")))         # FALSE
# hides_lgl(factor(c("yes","no","yes","maybe")),"maybe") # TRUE
# hides_lgl(c("1","2",NA))      # TRUE
# hides_lgl(c("1.5","2",NA))    # TRUE
# hides_lgl(factor(c(1,2,NA)))  # TRUE
# hides_lgl(c(1, 2, NA))        # TRUE
# hides_lgl(c(1.5, 2, NA))      # TRUE
# hides_lgl(c(1L, 2L, NA))      # TRUE
# hides_lgl(c(TRUE, FALSE, NA)) # FALSE
# hides_lgl(c(TRUE, FALSE, NA),   obvious = TRUE) # TRUE
#
# ## hides_mat
# hides_mat(list(1:5,6:10))                   # TRUE
# hides_mat(list(1:5,6:11))                   # FALSE
# hides_mat(list(letters[1:5],6:10))          # FALSE
# hides_mat(list(letters[1:5],letters[6:10])) # TRUE
#
# ## hides_df
# hides_df(list(1:5,6:10))                   # TRUE
# hides_df(list(1:5,6:11))                   # FALSE
# hides_df(list(letters[1:5],6:10))          # TRUE
# hides_df(list(letters[1:5],letters[6:10])) # TRUE
# hides_df(iris)                             # FALSE
# hides_df(as.list(iris))                    # TRUE
# hides_df(iris, obvious = TRUE)             # TRUE
#
# ## hides_vec
# hides_vec(list("a","b","c"))              # TRUE
# hides_vec(list(1,2,3))                    # TRUE
# hides_vec(list("a",2,3L))                 # FALSE
# hides_vec(list(c("a","z"),"b","c"))       # FALSE
# hides_vec(c("a","b","c"))                 # FALSE
# hides_vec(c("a","b","c"), obvious = TRUE) # TRUE
#'
#' @name hides
NULL