hydroToolkit (version 0.1.0)

report_hydroMet: Object summaries

Description

This method returns a list with two elements: the first one is a data frame with miss data (see also report_miss_data) and the second one is also a data frame with the mean, sd, max and min values.

Usage

report_hydroMet(
  obj,
  slot_name,
  col_name,
  start_date = NULL,
  end_date = NULL,
  Lang = "spanish"
)
# S4 method for hydroMet_BDHI
report_hydroMet(
  obj,
  slot_name,
  col_name,
  start_date = NULL,
  end_date = NULL,
  Lang = "spanish"
)
# S4 method for hydroMet_CR2
report_hydroMet(
  obj,
  slot_name,
  col_name,
  start_date = NULL,
  end_date = NULL,
  Lang = "spanish"
)
# S4 method for hydroMet_DGI
report_hydroMet(
  obj,
  slot_name,
  col_name,
  start_date = NULL,
  end_date = NULL,
  Lang = "spanish"
)
# S4 method for hydroMet_IANIGLA
report_hydroMet(
  obj,
  slot_name,
  col_name,
  start_date = NULL,
  end_date = NULL,
  Lang = "spanish"
)

Arguments

obj

an hydroMet_XXX object.

slot_name

a single or vector string containing the slot(s) to report.

col_name

a single or vector string with the name of the column to report in slot_name.

start_date

optional (default is the first Date). Single string or POSIXct with the starting Date to report.

end_date

optional (default is the last Date). Single string or POSIXct with the last Date to report.

Lang

optional (default value is spanish). Single string with the language to report results: spanish or english.

Value

A list containing two data frames: the first one with miss data and the second with the mean, sd, max and min values of the series.

Functions

• report_hydroMet,hydroMet_BDHI-method: report method for BDHI class

• report_hydroMet,hydroMet_CR2-method: report method for CR2 class

• report_hydroMet,hydroMet_DGI-method: report method for DGI class

• report_hydroMet,hydroMet_IANIGLA-method: report method for IANIGLA class

Examples

# NOT RUN {
# Create IANIGLA class
cuevas <- create_hydroMet(class_name = 'IANIGLA')
 
# List with meteorological variables (slots in BDHI's object)
cargar <- list( slotNames(x = 'hydroMet_IANIGLA')[2:11] )

# Assign as names the files
hydro_files   <- list.files( system.file('extdata', package = "hydroToolkit"), pattern = 'Cuevas' )
names(cargar) <- hydro_files

# Build met-station
cuevas <- build_hydroMet(obj = cuevas, slot_list = cargar, 
           path = system.file('extdata', package = "hydroToolkit") )

# Get report
report_hydroMet(obj = cuevas, slot_name = 'kin', col_name = 'kin_1')

# }