R/tbl.R

In whippr: Tools for Manipulating Gas Exchange Data

#' Construct a new tibble with metadata
#'
#' @param .data A data frame
#' @param metadata Metadata to be passed along with the data
#'
#' @return a [tibble][tibble::tibble-package]
#' @keywords internal
new_whippr_tibble <- function(.data, metadata) {
  if(!is.data.frame(.data))
    stop("You can only pass a data frame to this function.", call. = FALSE)

  whippr_tibble <- tibble::new_tibble(
    x = .data,
    nrow = nrow(.data),
    class = "whippr",
    read_data = metadata$read_data,
    metabolic_cart = metadata$metabolic_cart,
    data_status = metadata$data_status,
    time_column = metadata$time_column,
    vo2_column = metadata$vo2_column,
    test_type = metadata$test_type,
    processed_data = metadata$processed_data,
    incremental = metadata$incremental,
    normalized = metadata$normalized,
    incremental_type = metadata$incremental_type,
    has_baseline = metadata$has_baseline,
    baseline_length = metadata$baseline_length,
    baseline_intensity = metadata$baseline_intensity,
    ramp_increase = metadata$ramp_increase,
    step_start = metadata$step_start,
    step_increase = metadata$step_increase,
    step_length = metadata$step_length,
    outliers_detected = metadata$outliers_detected
  )

  tibble::validate_tibble(whippr_tibble)
  whippr_tibble
}

#' Whippr print method
#'
#' @param x A tibble with class 'whippr'
#' @param ... Extra arguments, not used.
#'
#' @export
print.whippr <- function(x, ...) {

  header <- paste("# Metabolic cart:", attr(x, "metabolic_cart"), "\n")

  if(!is.null(attr(x, "data_status")))
    header <- paste0(header, "# Data status: ", attr(x, "data_status"), "\n")

  if(!is.null(attr(x, "time_column")))
    header <- paste0(header, "# Time column: ", attr(x, "time_column"), "\n")

  if(!is.null(attr(x, "vo2_column")))
    header <- paste0(header, "# VO2 column: ", attr(x, "vo2_column"), "\n")

  if(!is.null(attr(x, "test_type")))
    header <- paste0(header, "# Test type: ", attr(x, "test_type"), "\n")

  # INCREMENTAL -------------------------------------------------------------

  if(!is.null(attr(x, "incremental"))) {
    if(attr(x, "incremental_type") == "ramp") {
      if(!is.null(attr(x, "has_baseline"))) {
        header <- paste0(header, "# Protocol: ",
                         attr(x, "baseline_length"),
                         "-s baseline at ",
                         attr(x, "baseline_intensity"),
                         " W and a ",
                         attr(x, "ramp_increase"),
                         "-W/min ramp",
                         "\n")
      } else {
        header <- paste0(header, "# Protocol: ",
                         attr(x, "no baseline"),
                         " and a ",
                         attr(x, "ramp_increase"),
                         "-W/min ramp",
                         "\n")
      }
    } else if(attr(x, "incremental_type") == "step") {
      if(!is.null(attr(x, "has_baseline"))) {
        if(!is.null(attr(x, "step_start"))) {
          header <- paste0(header, "# Protocol: ",
                           attr(x, "baseline_length"),
                           "-s baseline at ",
                           attr(x, "baseline_intensity"),
                           " W and ",
                           attr(x, "step_length"),
                           "-s steps of ",
                           attr(x, "step_increase"),
                           " W starting at ",
                           attr(x, "step_start"),
                           " W",
                           "\n")
        } else {
          header <- paste0(header, "# Protocol: ",
                           attr(x, "baseline_length"),
                           "-s baseline at ",
                           attr(x, "baseline_intensity"),
                           " W and ",
                           attr(x, "step_length"),
                           "-s steps of ",
                           attr(x, "step_increase"),
                           " W",
                           "\n")
        }
      } else {
        if(!is.null(attr(x, "step_start"))) {
          header <- paste0(header, "# Protocol: ",
                           attr(x, "no baseline"),
                           " and ",
                           attr(x, "step_length"),
                           "-s steps of ",
                           attr(x, "step_increase"),
                           " W starting at ",
                           attr(x, "step_start"),
                           " W",
                           "\n")
        } else {
          header <- paste0(header, "# Protocol: ",
                           attr(x, "no baseline"),
                           " and ",
                           attr(x, "step_length"),
                           "-s steps of ",
                           attr(x, "step_increase"),
                           " W",
                           "\n")
        }
      }
    }
  }

  cat(pillar::style_subtle(header))

  NextMethod()
}