R/export.sc_pnd.R

In jazznbass/scan: Single-Case Data Analyses for Single and Multiple Baseline Designs

#' @rdname export
#' @export
export.sc_pnd <- function(object, 
                          caption = NA, 
                          footnote = NA, 
                          filename = NA,
                          kable_styling_options = list(), 
                          kable_options = list(), 
                          select = c("Case", "PND", "Total", "Exceeds"),
                          round = 2,
                          ...) {
  
  kable_options <- .join_kabel(kable_options)
  kable_styling_options <- .join_kabel_styling(kable_styling_options)
  
  if (is.na(caption)) caption <- c("Percentage Non-Overlapping Data")
  
  out <- data.frame(
    Case = object$case.names, 
    PND = object$PND, 
    Total = object$n.B, 
    Exceeds = round(object$n.B * object$PND / 100)
  )
  out <- .select(out, select)
  
  out <- round_numeric(out, round)
  
  table <- .create_table(
    out, 
    kable_options, 
    kable_styling_options, 
    caption = caption,
    footnote = footnote,
    ...
  )
  
  # finish ------------------------------------------------------------------
  
  if (!is.na(filename)) .save_export(table, filename)
  
  table
}