gr_summarize: Summarize hydrograph separation

View source: R/summarize.R

gr_summarizeR Documentation

Summarize hydrograph separation

Description

Use this function to get meaningful summary statistics for hydrograph separation. Resulting variables are described by gr_help_vars(). This function is a convenient wrapper around dplyr's df %>% group_by %>% summarize idiom.

Usage

gr_summarize(df, year_min = NULL, year_max = NULL)

Arguments

df

data.frame of hydrograph separation resulting from gr_separate() function

year_min

integer first year to summarise

year_max

integer last year to summarise

Value

data.frame with one row for each water-resources year and multiple columns of statistics explained by gr_help_vars().

Examples

library(grwat)

data(spas) # example Spas-Zagorye data is included with grwat package

# separate
sep = gr_separate(spas, params = gr_get_params(reg = 'center'))

# summarize
vars = gr_summarize(sep)

head(vars)

gr_plot_vars(vars, Qygr, tests = TRUE)

tsamsonov/grwat documentation built on Feb. 10, 2024, 5:55 p.m.