Skip to contents

Group data by categorical variables and calculate summary statistics

Usage

groupsummary(
  data,
  groupVars,
  sumVars,
  statistics = list("sum", "mean", "n"),
  dateVar,
  dateFormat = "ymd",
  timeAggregation = "day",
  showMissing = FALSE,
  addPercentage = TRUE,
  sortBy = "groups"
)

Arguments

data

The data as a data frame.

groupVars

Variables to group by (categorical or date).

sumVars

Numeric variables to calculate statistics for each group.

statistics

.

dateVar

Select the date variable from group variables to apply date formatting.

dateFormat

.

timeAggregation

.

showMissing

Include groups with missing values in the summary.

addPercentage

Add percentage of total for sum values.

sortBy

.

Value

A results object containing:

results$todoa html
results$dateInfoa html
results$summaryTablea table
results$plotan image

Tables can be converted to data frames with asDF or as.data.frame. For example:

results$summaryTable$asDF

as.data.frame(results$summaryTable)

Examples

# \donttest{
# Group by one or more categorical variables and sum numeric variables
groupsummary(
    data = mydata,
    groupVars = c("Category", "Group"),
    sumVars = c("Value1", "Value2")
)
#> Error in groupsummary(data = mydata, groupVars = c("Category", "Group"),     sumVars = c("Value1", "Value2")): argument "dateVar" is missing, with no default
# }