tk_summary_diagnostics: Group-wise Time Series Summary

In business-science/timekit: A Tool Kit for Working with Time Series

Group-wise Time Series Summary

Description

tk_summary_diagnostics() returns the time series summary from one or more timeseries groups in a tibble.

Usage

tk_summary_diagnostics(.data, .date_var)

Arguments

.data	A tibble or data.frame with a time-based column
.date_var	A column containing either date or date-time values. If missing, attempts to auto-detect the date or date-time column.

Details

Applies tk_get_timeseries_summary() group-wise returning the summary of one or more time series groups.

• Respects dplyr groups

• Returns the time series summary from a time-based feature.

Value

A tibble or data.frame with timeseries summary features

Examples

library(dplyr)

# ---- NON-GROUPED EXAMPLES ----

# Monthly Data
m4_monthly %>%
    filter(id == "M750") %>%
    tk_summary_diagnostics()

# ---- GROUPED EXAMPLES ----

# Monthly Data
m4_monthly %>%
    group_by(id) %>%
    tk_summary_diagnostics()

business-science/timekit documentation built on Feb. 2, 2024, 2:51 a.m.