distantia (version 2.0.2)

tsl_time: Time Features of Time Series Lists

Description

The functions tsl_time() and tsl_time_summary() summarize the time features of a time series list.

• tsl_time() returns a data frame with one row per time series in the argument 'tsl'

• tsl_time_summary() returns a list with the features captured by tsl_time(), but aggregated across time series.

Both functions return keywords useful for the functions tsl_aggregate() and tsl_resample(), depending on the value of the argument keywords.

Usage

tsl_time(tsl = NULL, keywords = c("resample", "aggregate"))
tsl_time_summary(tsl = NULL, keywords = c("resample", "aggregate"))

Value

• tsl_time(): data frame with the following columns:

  • name (string): time series name.

  • rows (integer): number of observations.

  • class (string): time class, one of "Date", "POSIXct", or "numeric."

  • units (string): units of the time series.

  • length (numeric): total length of the time series expressed in units.

  • resolution (numeric): average interval between observations expressed in units.

  • begin (date or numeric): begin time of the time series.

  • end (date or numeric): end time of the time series.

  • keywords (character vector): valid keywords for tsl_aggregate() or tsl_resample(), depending on the value of the argument keywords.

• tsl_time_summary(): list with the following objects:

  • class (string): time class, one of "Date", "POSIXct", or "numeric."

  • units (string): units of the time series.

  • begin (date or numeric): begin time of the time series.

  • end (date or numeric): end time of the time series.

  • resolution_max (numeric): longer time interval between consecutive samples expressed in units.

  • resolution_min (numeric): shorter time interval between consecutive samples expressed in units.

  • keywords (character vector): valid keywords for tsl_aggregate() or tsl_resample(), depending on the value of the argument keywords.

  • units_df (data frame) data frame for internal use within tsl_aggregate() and tsl_resample().

Arguments

tsl

(required, list) Time series list. Default: NULL

keywords

(optional, character string or vector) Defines what keywords are returned. If "aggregate", returns valid keywords for zoo_aggregate(). If "resample", returns valid keywords for zoo_resample(). If both, returns all valid keywords. Default: c("aggregate", "resample").

See Also

Other tsl_management: tsl_burst(), tsl_colnames_clean(), tsl_colnames_get(), tsl_colnames_prefix(), tsl_colnames_set(), tsl_colnames_suffix(), tsl_count_NA(), tsl_diagnose(), tsl_handle_NA(), tsl_join(), tsl_names_clean(), tsl_names_get(), tsl_names_set(), tsl_names_test(), tsl_ncol(), tsl_nrow(), tsl_repair(), tsl_subset(), tsl_to_df()

Examples

#simulate a time series list
tsl <- tsl_simulate(
  n = 3,
  rows = 150,
  time_range = c(
    Sys.Date() - 365,
    Sys.Date()
  ),
  irregular = TRUE
)

#time data frame
tsl_time(
  tsl = tsl
)

#time summary
tsl_time_summary(
  tsl = tsl
)