Preformatted reference line

reference_line(
  label_name,
  ref_line,
  scale_amount = 1,
  model_name = "1",
  direction = "h"
)

Arguments

label_name

String. Name of the quantity that users want to extract the reference point from

ref_line

String. Reference point(s)

scale_amount

Number. A number to scale the y-axis values. If > 1, the magnitude of the scale amount will be added to the unit label (e.g. scale_amount = 1000 with a unit label of "1000s of lbs" will result in "thousands of 1000s of lbs")

Default: 1

model_name

String. Name of the model that will be present in the legend.

direction

String. Direction of reference line (either 'h' for horizontal or 'v' for vertical)

Options: Including, but not limited to: "msy", "unfished", "target"

Value

A ggplot2 geom_hline object for a reference point that can be added to a plot

Examples

if (FALSE) { # \dontrun{
reference_line(dat, "biomass", "msy")
} # }