R/recorded_dst.R

In JayAchar/tbcleanr: tbcleanr: tools for cleaning TB datade

#' Clean recorded baseline DST variable
#'
#' @param x data frame of TB admission data
#'
#' @return data frame with factorised baseline DST
#' @importFrom assertthat assert_that
#' @export

recorded_dst <- function(x) {
  assert_that(is.data.frame(x))

  UseMethod("recorded_dst", x)
}



#' Default method for recorded_dst()
#'
#' Allow data frames with unspecified object class to pass through
#' @param x data frame containing variables
#' @author Jay Achar
#' @seealso \code{\link{tbcleanr}}
#' @export

recorded_dst.default <- function(x) {

  # check whether adm object class can be applied
  y <- adm_classr(x)

  # recycle if class sucessfully applied
  if (length(class(y)) > length(class(x))) {

    adm_subset(y)

  } else {

    message("No adm object class detected: recorded_dst() not applied.")
  x
  }

}