link_stats_table: Link Statistics Table

Description Usage Arguments Value Examples

View source: R/assignment_tables.R

Description

Link Statistics Table

Usage

1
2
3
link_stats_table(links, volume, count, group_field = NULL,
  volume_breaks = c(0, 5, 10, 15, 20, 40, 60, Inf), type = c("rmse",
  "flow"))

Arguments

links

Model link table as a tidy data frame, with each row representing an analysis link. The function assumes that the data is already tidy: two-way links should already be converted to single values, etc.

volume

Character string identifying the modeled volume in the link table.

count

Character string identifying the calibration/validation counts in the link table.

group_field

Character string identifying variable to group observations by, for example facility type. If set to same value as volume, will cut into bins.

volume_breaks

Numeric vector passed on to cut() identifying the breakpoints in the volume groups. Number in thousands, i.e.: 10, 20

type

Which type of table to print. Currently supports percent RMSE and total flow deviation.

Value

A data_frame with the link summary table.

Examples

1
2
3
4
link_stats_table(links, "volume", "count", group_field = "area_name", type = "rmse")
link_stats_table(links, "volume", "count", group_field = "area_name", type = "flow")
link_stats_table(links, "volume", "count", group_field = "facility_group", type = "rmse")
link_stats_table(links, "volume", "count", group_field = "facility_group", type = "flow")

pbsag/outviz documentation built on Dec. 7, 2019, 5:50 a.m.