hydrotoolbox (version 1.1.2)

hm_report: Get a summary report of your data

Description

Returns a list with two elements: the first one contains basic statistics (mean, sd, max and min) values and the second one is a table with summary of miss data (see also report_miss).

Usage

hm_report(obj, slot_name, col_name = "all")
# S4 method for hydromet_station
hm_report(obj, slot_name, col_name = "all")
# S4 method for hydromet_compact
hm_report(obj, slot_name = "compact", col_name = "all")

Value

A list summarizing basic statistics and missing data. The missing data table presents a data frame (one per col_name) with three columns: start-date, end-date and number of missing time steps. In the last row of this table you will find the total number of missing measurements (under "time_step" column). The "first" and "last" columns will have a NA_character for this last row.

Arguments

obj

a valid hydromet_XXX class object.

slot_name

string with the name of the slot to report.

col_name

string vector with the column(s) name(s) to report. By default the function will do it in all columns inside the slot.

Functions

• hm_report(hydromet_station): report method for station class

• hm_report(hydromet_compact): report method for compact class

Examples

if (FALSE) {
# cuevas station
path <- system.file('extdata', package = 'hydrotoolbox')

# use the build method
hm_cuevas <-
  hm_create() %>%
  hm_build(bureau = 'ianigla', path = path,
           file_name = 'ianigla_cuevas.csv',
           slot_name = c('tair', 'rh', 'patm',
                         'precip', 'wspd', 'wdir',
                         'kin', 'hsnow', 'tsoil'),
           by = 'hour',
           out_name = c('tair(°C)', 'rh(%)', 'patm(mbar)',
                        'p(mm)', 'wspd(km/hr)', 'wdir(°)',
                        'kin(kW/m2)', 'hsnow(cm)', 'tsoil(°C)' )
          )

# report incoming solar radiation
hm_report(obj = hm_cuevas, slot_name = 'kin')
}