use_metrics_scaffold: Create a scaffold for documenting metrics

In datacamp/tidymetrics: A Tidy Approach to Dimensional Modeling

Description

Use this to generate a YAML scaffold for documenting metrics, just prior to running create_metrics(). You can place this into the header of an Rmd and fill in the names and descriptions.

Usage

use_metrics_scaffold(tbl)

Arguments

tbl	A wide metric tbl, including date, period, optionally one or more dimensions, and one or more calculated metrics.

Examples

library(dplyr)

flights <- nycflights13::flights %>%
  mutate(date = as.Date(ISOdate(year, month, day)))

# find flight delays by week, month, and quarter
flight_summary <- flights %>%
  cross_by_dimensions(origin) %>%
  cross_by_periods() %>%
  summarize(
    nb_flights = n(),
    avg_arr_delay = mean(arr_delay, na.rm = TRUE)
  )

use_metrics_scaffold(flight_summary)

datacamp/tidymetrics documentation built on March 21, 2021, 3:28 a.m.