summary.DTSg: Summarise time series data

In gisler/DTSg: A Class for Working with Time Series Data Based on 'data.table' and 'R6' with Largely Optional Reference Semantics

Summarise time series data

Description

Calculates summary statistics of selected columns of a DTSg object.

Usage

## S3 method for class 'DTSg'
summary(object, cols = self$cols(), ...)

Arguments

object	A DTSg object (S3 method only).
cols	A character vector specifying the columns whose values shall be summarised. Another possibility is a character string containing either comma separated column names, for example, "x,y,z", or the start and end column separated by a colon, for example, "x:z".
...	Further arguments passed on to summary.data.frame.

Value

Returns a table.

See Also

cols

Examples

# new DTSg object
x <- DTSg$new(values = flow)

# calculate summary statistics
## R6 method
x$summary()

## S3 method
summary(object = x)

gisler/DTSg documentation built on Dec. 12, 2024, 1:23 a.m.