R/fail_drugs.R

In JayAchar/tbgeneratr: tbgenratr: tools for generating new TB variables

#' Fail - 2 drugs changed 
#'
#' This function detects whether a record diagnosed with DR-TB
#' should receive a failure outcome due to two drugs being ceased within a designated interval.
#' 
#' @param adm data frame of individual patient admission records cleaned 
#' with `tbcleanr`.
#' @param change data frame of individual patient follow-up data including
#' monthly drug-specific adherence data cleaned by `tbcleanr::adhere_cleanr()`
#' @param stop_days define interval in days where two drugs being stopped would result in failure. 
#' @author Jay Achar
#' @seealso \code{\link{tbgeneratr}}
#' @importFrom assertthat assert_that

fail_drugs <- function(adm,
                      change,
                      stop_days = 30) {
  
  
  # check args
  assert_that(is.data.frame(adm),
              is.data.frame(change))
  
  UseMethod("fail_drugs", adm)
  
}


#' Fail - 2 drugs changed
#'
#' @inheritParams fail_drugs
#' @author Jay Achar
#' @seealso \code{\link{tbgeneratr}}

fail_drugs.default <- function(adm, change, stop_days = 30) {
  
  message("No object class detected: fail_drugs() not applied.")
  adm
  
}