check_time_series_collection: Check that a collection of time series is properly formatted

In vctsfr: Visualizing Collections of Time Series Forecasts

Check that a collection of time series is properly formatted

Description

This function checks that an object holding a collection of time series, their future values and their forecasts has the correct format. This kind of objects are used in function plot_collection(). A collection of time series should be a list compounded of objects of class ts_info, which are built using the ts_info() function.

Usage

check_time_series_collection(collection)

Arguments

collection

a list representing a collection of time series as described in plot_collection().

Value

a character string with value "OK" if the object is properly formatted. Otherwise, the character string indicates the first error found in the object's format.

Examples

c <- list(ts_info(USAccDeaths), ts_info(ldeaths))
check_time_series_collection(c)

vctsfr documentation built on May 29, 2024, 9:47 a.m.