Summarise time series data

Source: R/Swrappers.R

Calculates summary statistics of selected columns of a DTSg object.

# S3 method for 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()
#>       flow        
#>  Min.   :  4.995  
#>  1st Qu.:  8.085  
#>  Median : 11.325  
#>  Mean   : 16.197  
#>  3rd Qu.: 18.375  
#>  Max.   :290.715  
#>  NA's   :23       

## S3 method
summary(object = x)
#>       flow        
#>  Min.   :  4.995  
#>  1st Qu.:  8.085  
#>  Median : 11.325  
#>  Mean   : 16.197  
#>  3rd Qu.: 18.375  
#>  Max.   :290.715  
#>  NA's   :23