R/mds_chkmds.R

#' @title mds_chkmds: Generate a report on MDS data.frame
#'
#' @description Called when testing an object is MDS canonical
#'
#' @usage mds_chkmds(mds_obj, .report=T)
#'
#' @param mds_obj A data.frame class object.
#'
#' @return Prints output to console
#'
#' @export
#'
#' @examples
#' require(mdsR)
#' mds_dta <- mdsR::mds_cohort
#' mds_chkmds(mds_dta)
#'
mds_chkmds <- function(mds_obj) {

  obj_name <- rlang::quo(mds_obj)

  ## Print summary statistics
    cat('General Report on Minimum Dataset File \n')
    cat('R global environment, object: ', paste0(rlang::quo_text(obj_name), '\n'))
    cat('Date Created: ', Scotty::TimeStamp(), 'Programmer: ', 'KWM',  '\n')


  ## Evaluate standard



  ##Pull non-standards
  var_nms <- mdsR::mds_varlist[mds_varlist$standard=='non-std', ]$item

}
kmcconeghy/mdsr documentation built on May 3, 2019, 1:47 p.m.