add_calculated_row: Add Calculated Row

In cards: Analysis Results Data

Add Calculated Row

Description

Use this function to add a new statistic row that is a function of the other statistics in an ARD.

Usage

add_calculated_row(
  x,
  expr,
  stat_name,
  by = c(all_ard_groups(), all_ard_variables(), any_of("context")),
  stat_label = stat_name,
  fmt_fn = NULL
)

Arguments

x	(card) data frame of class 'card'
expr	(expression) an expression
stat_name	(string) string naming the new statistic
by	(tidy-select) Grouping variables to calculate statistics within
stat_label	(string) string of the statistic label. Default is the stat_name.
fmt_fn	(integer, function, string) a function of an integer or string that can be converted to a function with alias_as_fmt_fn().

Value

an ARD data frame of class 'card'

Examples

ard_continuous(mtcars, variables = mpg) |>
  add_calculated_row(expr = max - min, stat_name = "range")

ard_continuous(mtcars, variables = mpg) |>
  add_calculated_row(
    expr =
      dplyr::case_when(
        mean > median ~ "Right Skew",
        mean < median ~ "Left Skew",
        .default = "Symmetric"
      ),
    stat_name = "skew"
  )

cards documentation built on Oct. 4, 2024, 1:09 a.m.