attribute_summary: Get data frame summary statistics for one or all columns of a...

In duncankmckinnon/OKdplyr: Zero Kelvin dplyr

Description

generate summary for a given attribute grouped by a target attribute

Usage

attribute_summary(
  data,
  summary_attr = NULL,
  group_attr = NULL,
  .checkAssertions = TRUE
)

Arguments

data	a data frame or tibble type object
summary_attr	a column label as a string to summarize
group_attr	a column label to group by before summarizing (optional)
.checkAssertions	private variable used to check function assertions (if first in chain)

Value

a list containing a summary table for all attributes or the specified summary_attr (if present), grouped by the group_attr (if present)

Examples

# summarise all columns
attribute_summary(iris)

# summarise only 'Petal.Length'
attribute_summary(iris, summary_attr='Petal.Length')

# summarise 'Petal.Length' grouped by 'Species'
attribute_summary(iris, summary_attr='Petal.Length', group_attr='Species')

# summarise all columns grouped by 'Species'
attribute_summary(iris, group_attr='Species')

duncankmckinnon/OKdplyr documentation built on Nov. 30, 2020, 1:13 a.m.