Plot method for discharge rating curves

Source: R/plm_methods.R

Visualize discharge rating curve model objects

# S3 method for plm0
plot(
  x,
  ...,
  type = "rating_curve",
  param = NULL,
  transformed = FALSE,
  title = NULL,
  xlim = NULL,
  ylim = NULL
)

# S3 method for plm
plot(
  x,
  ...,
  type = "rating_curve",
  param = NULL,
  transformed = FALSE,
  title = NULL,
  xlim = NULL,
  ylim = NULL
)

# S3 method for gplm0
plot(
  x,
  ...,
  type = "rating_curve",
  param = NULL,
  transformed = FALSE,
  title = NULL,
  xlim = NULL,
  ylim = NULL
)

# S3 method for gplm
plot(
  x,
  ...,
  type = "rating_curve",
  param = NULL,
  transformed = FALSE,
  title = NULL,
  xlim = NULL,
  ylim = NULL
)

Arguments

x

object of class "plm0", "plm", "gplm0" or "gplm".

...

other plotting parameters (not used in this function)

type

a character denoting what type of plot should be drawn. Defaults to "rating_curve". Possible types are

  • "rating_curve" to plot the rating curve.

  • "rating_curve_mean" to plot the posterior mean of the rating curve.

  • "f" to plot the power-law exponent.

  • "beta" to plot the random effect in the power-law exponent.

  • "sigma_eps" to plot the standard deviation on the data level.

  • "residuals" to plot the log residuals.

  • "trace" to plot trace plots of parameters given in param.

  • "histogram" to plot histograms of parameters given in param.

  • "panel" to plot a 2x2 panel of plots: "rating curve", "residuals", "f" and "sigma_eps"

param

a character vector with the parameters to plot. Defaults to NULL and is only used if type is "trace" or "histogram". Allowed values are the parameters given in the model summary of x as well as "hyperparameters" or "latent_parameters" for specific groups of parameters.

transformed

a logical value indicating whether the quantity should be plotted on a transformed scale used during the Bayesian inference. Defaults to FALSE.

title

a character denoting the title of the plot

xlim

numeric vector of length 2, denoting the limits on the x axis of the plot. Applicable for types "rating_curve","rating_curve_mean","f","beta","sigma_eps","residuals".

ylim

numeric vector of length 2, denoting the limits on the y axis of the plot. Applicable for types "rating_curve","rating_curve_mean","f","beta","sigma_eps","residuals".

Value

No return value, called for side effects.

Functions

  • plot(plm0): Plot method for plm0

  • plot(plm): Plot method for plm

  • plot(gplm0): Plot method for gplm0

  • plot(gplm): Plot method for gplm

See also

plm0, plm, gplm0 and gplm for fitting a discharge rating curve and summary.plm0, summary.plm, summary.gplm0 and summary.gplm for summaries. It is also useful to look at spread_draws and gather_draws to work directly with the MCMC samples.

Examples

# \donttest{
data(krokfors)
set.seed(1)
plm0.fit <- plm0(formula=Q~W,data=krokfors,num_cores=2)

plot(plm0.fit)

plot(plm0.fit,transformed=TRUE)

plot(plm0.fit,type='histogram',param='c')

plot(plm0.fit,type='histogram',param='c',transformed=TRUE)

plot(plm0.fit,type='histogram',param='hyperparameters')

plot(plm0.fit,type='histogram',param='latent_parameters')

plot(plm0.fit,type='residuals')

plot(plm0.fit,type='f')

plot(plm0.fit,type='sigma_eps')

# }