`R/plot_data_screening.R`

`plot_data_screening.Rd`

Plots the mean, median, maximum, minimum, standard deviation of annual flows. Calculates statistics
from all values, unless specified. Data calculated using `screen_flow_data()`

function. Returns a list of plots.

plot_data_screening( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, months = 1:12, start_year, end_year, include_title = FALSE )

data | Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank if using |
---|---|

dates | Name of column in |

values | Name of column in |

groups | Name of column in |

station_number | Character string vector of seven digit Water Survey of Canada station numbers (e.g. |

roll_days | Numeric value of the number of days to apply a rolling mean. Default |

roll_align | Character string identifying the direction of the rolling mean from the specified date, either by the first
( |

water_year_start | Numeric value indicating the month ( |

months | Numeric vector of months to include in analysis (e.g. |

start_year | Numeric value of the first year to consider for analysis. Leave blank to use the first year of the source data. |

end_year | Numeric value of the last year to consider for analysis. Leave blank to use the last year of the source data. |

include_title | Logical value to indicate adding the group/station number to the plot, if provided. Default |

A list of ggplot2 objects with the following for each station provided:

a plot that contains annual summary statistics for screening

annual minimum of all daily flows for a given year

annual maximum of all daily flows for a given year

annual mean of all daily flows for a given year

annual 1 standard deviation of all daily flows for a given year

# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot screening statistics using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_data_screening(data = flow_data) # Plot screening statistics using station_number argument with defaults plot_data_screening(station_number = "08NM116") # Plot screening statistics for water years starting in October plot_data_screening(station_number = "08NM116", water_year_start = 10) # Plot screening statistics for 7-day flows for July-September months only plot_data_screening(station_number = "08NM116", roll_days = 7, months = 7:9) }#> $Data_Screening#>