R/result_consolidator.R

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

#' Consolidate smear and culture results
#'
#' Take laboratory data set and consolidate repeated results to give summary variable
#' @param x data frame containing variables
#' @param rm_orig remove original variables - TRUE or FALSE
#' @param ... further arguments passed to or from other methods
#' @author Jay Achar 
#' @seealso \code{\link{tbcleanr}}
#' @export
#' @importFrom assertthat assert_that

result_consolidator <- function(x, rm_orig = TRUE, ...) {

  # check input
  assert_that(is.data.frame(x))

  UseMethod("result_consolidator", x)
}


#' Default method for result_consolidator()
#'
#' Allow data frames with unspecified object class to pass through
#' @inheritParams result_consolidator
#' @author Jay Achar
#' @seealso \code{\link{tbcleanr}}
#' @export

result_consolidator.default <- function(x, rm_orig = TRUE, ...) {

  message("No lab object class detected: result_consolidator() not applied.")
  x
}