R/mean_summary.R

In ingels11/TableRExtracts: Table Extracts and Data Labeling

#' Functions used to add a mean value to codebooks
#'
#' A set of functions that will help to add the line of mean value
#' to codebooks.
#'
#' @param v Vector of values in a dataset
#' @param maxDecimals Maximum number of decimals to display (default = 2)
#' @export
meanSummary <- function(v, maxDecimals = 2) {
  UseMethod("meanSummary")
}

#' @export
meanSummary.numeric <- function(v, maxDecimals = 2) {
  meanSummaryHelper(v, maxDecimals)
}

# meanSummary <- summaryFunction(meanSummary,
#                                description = "Compute arithmetic mean")

# integer
meanSummary.integer <- function(v, maxDecimals = 2) {
  meanSummaryHelper(v, maxDecimals)
}

meanSummaryHelper <- function(v, maxDecimals) {
  # remove missing observations
  v <- stats::na.omit(v)

  # compute mean and store "raw" output in `val`
  val <- mean(v)

  # store printable output in `res`
  res <- round(val, maxDecimals)

  # output summaryREsults
  dataMaid::summaryResult(list(feature = "Mean", result = res, value = val))
}