get_series_info: Function gets both time and starting data information on a...

View source: R/get_series_info.R

get_series_infoR Documentation

Function gets both time and starting data information on a ts, zoo, or xts time series object

Description

The function returns a short synopsis data.frame of a time series object and optionally its starting observations.

Usage

get_series_info(series = NULL, n_obser = NULL)

Arguments

series

Either a ts, zoo, or xts time series object

n_obser

An integer that sets the number of observations to display. If NULL then no observations are included in the data.frame.

Value

A named list with the series statistics(named "stats") and sample values(named "data").

Author(s)

Rick Dean


deandevl/RtsaPkg documentation built on Oct. 5, 2023, 5:23 p.m.