R/utilities.R

In rapidsurveys/squeacr: Semi-Quantitative Evaluation of Access and Coverage (SQUEAC) Tools in R

################################################################################
#
#'
#' Find possible variable names from a data.frame given a set of search names
#'
#' @param .data A data.frame to search variable names from
#' @param vars A vector of terms to search for
#' @param all Logical. Should all results of search be returned? If FALSE
#'   (default), only first value is returned.
#'
#' @return A character vector of variable name/s in `.data`
#'
#' @author Ernest Guevarra
#'
#' @examples
#' find_var_names(.data = muac_admission, vars = "MUAC")
#'
#' @export
#'
#
################################################################################

find_var_names <- function(.data, vars, all = FALSE) {
  ## Make variables and search names lower case
  x <- tolower(names(.data))
  .vars <- tolower(vars)

  ## Compose search term
  search_term <- paste(.vars, collapse = "|")

  ## Get data variable names matching search
  z <- names(.data)[stringr::str_detect(x, pattern = search_term)]

  ## Check if z is empty
  if(length(z) == 0) {
    message("No matching variable name/s. Try again.")
    z <- NULL
  }

  ## Check if all is TRUE
  if(length(z) > 1) z <- z[1]

  ## Return result
  z
}


################################################################################
#
#'
#' Apply median of 3 and average of 3 smoothing on a time series
#'
#' @param x A vector of numerical information to be smoothed
#'
#' @return A vector of smoothed data
#'
#' @author Ernest Guevarra
#'
#' @examples
#' x <- aggregate(cbind(`New Admissions`, Default) ~ Month + Year,
#'                data = monitoring, FUN = sum)
#' smooth_m3a3(x = x$Default)
#'
#' @export
#'
#
################################################################################

smooth_m3a3 <- function(x) {
  ## Check if numeric
  if(!is.numeric(x)) {
    stop("Input vector should be numeric. Try again.", call. = TRUE)
  }

  ## Median of 3
  y <- zoo::rollmedian(x = x, k = 3, fill = c("extend", NA))

  ## Average of 3
  z <- zoo::rollmean(x = y, k = 3, fill = c("extend", NA))

  ## Return results
  z
}