R/utils.R

In dylanrussellmd/nsqipr: Interact with NSQIP data via R

#' Quick Search
#'
#' Quick case-insensitive search of strings in a character vector
#'
#' @param str a character vector: the values to be matched
#' @param vec a character vector: the values to be matched against
#'
#' @details Utilizes \code{data.table::%chin%} to rapidly complete a case-insensitive search
#' through a character vector to return a logical vector of string detections.
#' Will always return TRUE or FALSE for each position of \code{str} regardless of NA missing values
#' in either provided vector. NA in \code{str} will never match an NA value in \code{vec}.
#'
#' @return a logical vector of length \code{length(str)}
#'
#' @importFrom data.table %chin%
#' @importFrom stats na.omit
#' @keywords internal
#'
#' @examples
#' x <- c("apple","banana","cherry",NA)
#' nsqipr:::`%qsin%`("apple",x) # could also use "apple" %qsin% x
#' nsqipr:::`%qsin%`(c("APPLE","BANANA","coconut", NA), x)
#'
`%qsin%` <- function(str, vec) {
  tolower(str) %chin% na.omit(tolower(vec))
}

#' Check if a data table is full
#'
#' @param x a data.table
#'
#' @details Will return TRUE if the object supplied is a non-empty data.table.
#' Otherwise, returns FALSE.
#'
#' @keywords internal
#'
#' @examples
#' nsqipr:::isFullDT(NULL)
#' nsqipr:::isFullDT("test")
#' nsqipr:::isFullDT(NA)
#' nsqipr:::isFullDT(data.table::data.table())
#' nsqipr:::isFullDT(data.table::data.table(test = numeric(), test2 = logical(), test3 = character()))
#' nsqipr:::isFullDT(data.table::data.table(test = 1, test2 = TRUE, test3 = "character"))
#'
isFullDT<- function(x) all(data.table::is.data.table(x), (nrow(x) > 0))