Skip to contents

Report median-quantiles summaries

Usage

report_quantiles(data, summary_vrs, grouping_vrs = NULL)

Arguments

data

A data frame including numeric variables to be summarized.

summary_vrs

A character vector specifying the numeric variables to be summarized.

grouping_vrs

A character vector specifying the grouping variables, if any.

Value

A dataframe of the class 'quantiles_report', containing a 'report' column, which report the 'median (quartile 1-quartile 3)' combinations for each specified numeric variable, at each grouping key.

Examples

# \donttest{
if (FALSE) {
library(phdcocktail)
summary_data <- report_quantiles(mtcars, summary_vrs = "mpg")
print(summary_data)
  }
# }