summarise_data: Summarise time series data

In tscv: Functions and Utilities for Tidy Time Series Forecasting and Time Series Cross-Validation

Summarise time series data

Description

Calculate basic data-quality summary statistics for one or more time series.

Usage

summarise_data(.data, context)

Arguments

.data	A tibble in long format containing time series data.
context	A named list with the identifiers for series_id, value_id, and index_id.

Details

summarise_data() groups the input data by the series identifier supplied in context and returns one row per time series.

The function reports:

• start: first time index;

• end: last time index;

• n_obs: number of observations;

• n_missing: number of missing values;

• pct_missing: percentage of missing values;

• n_zeros: number of zero values;

• pct_zeros: percentage of zero values.

Value

A tibble containing one row per time series and the calculated summary statistics.

See Also

Other data analysis: acf_vec(), estimate_acf(), estimate_kurtosis(), estimate_mode(), estimate_pacf(), estimate_skewness(), pacf_vec(), summarise_split(), summarise_stats()

Examples

library(dplyr)

context <- list(
  series_id = "series",
  value_id = "value",
  index_id = "index"
)

data <- M4_monthly_data |>
  filter(series %in% c("M23100", "M14395"))

summarise_data(
  .data = data,
  context = context
)

tscv documentation built on May 13, 2026, 9:07 a.m.