weighingGaugePlot: Plots weighing gauge precipitation

View source: R/weightingGaugePlot.R

weighingGaugePlotR Documentation

Plots weighing gauge precipitation

Description

Plots culumative precipitation data from a weighting gauge. The plot contains facets with the cumulative and interval precipitations plotted against time.

Usage

weighingGaugePlot(
  obs,
  precipCol = 1,
  startDate = "",
  endDate = "",
  showMissing = TRUE
)

Arguments

obs

Required. A standard CRHMr obs dataframe.

precipCol

Optional. The column containing the cumulative precipitation data. Default is column 1.

startDate

Optional. The starting date for the plot. Can either be a year as a number (e.g. 1995) or a date in Y-m-d format, i.e. 1995-06-01. If not specified, the first datetime value in the obs data is used.

endDate

Optional. The ending date for the plot. Can either be a year as a number (e.g. 1995) or a date in Y-m-d format, i.e. 1995-12-31. If not specified, the first datetime value in the obs data is used.

showMissing

Optional. If set to TRUE (the default), then the position of missing values will be indicated by red points on the x-axis.

Value

If successful returns a ggplot2 object. If unsuccessful, returns the value FALSE.

Author(s)

Kevin Shook.

See Also

weighingGauge1 weighingGauge2 weighingGauge3 weighingGauge4 weighingGauge5

Examples

## Not run: 
p <- weighingGaugePlot(test1) 
## End(Not run)

CentreForHydrology/CRHMr documentation built on April 6, 2024, 5:27 p.m.