Skip to contents

WaterLevelDataFrame summary

Source: R/WaterLevelDataFrame-methods.R
summary.WaterLevelDataFrame.Rd

Returns a list of descriptive statistics for an object of class WaterLevelDataFrame.

Usage 

# S3 method for WaterLevelDataFrame
summary(object, ...)

Arguments

object

an object of class WaterLevelDataFrame for which a summary is desired.

...

additional arguments to be passed to internally used functions.

Value

A list of summary statistics of the WaterLevelDataFrame

and its slots.

See also

summary

Examples 

wldf <- WaterLevelDataFrame(river   = "Elbe",
                            time    = as.POSIXct("2016-12-21"),
                            station = seq(257, 262, 0.1))
wldf <- waterLevel(wldf)
summary(wldf)
#> $slots
#>                                                          
#> river                                                Elbe
#> time                                           2016-12-21
#> gauging_stations         VOCKERODE, ROSSLAU, DESSAU, AKEN
#> gauging_stations_missing                             None
#> comment                         Computed by waterLevel().
#> 
#> $data
#>     station       station_int           w        
#>  Min.   :257.0   Min.   :257000   Min.   :54.42  
#>  1st Qu.:258.2   1st Qu.:258250   1st Qu.:54.67  
#>  Median :259.5   Median :259500   Median :54.82  
#>  Mean   :259.5   Mean   :259500   Mean   :54.87  
#>  3rd Qu.:260.8   3rd Qu.:260750   3rd Qu.:55.11  
#>  Max.   :262.0   Max.   :262000   Max.   :55.35  
#>