Plots a single vertical profile using output from get_ereefs_profile()

Relies on output from get_ereefs_profile().

plot_ereefs_profile(
  profile_obj = NULL,
  var_name = "Chl_a_sum",
  target_date = c(2016, 1, 1),
  p = NA,
  colour = "blue",
  profileObj = NULL
)

Arguments

profile_obj

A list object as output by [get_ereefs_profile()], containing dates, eta, z_grid, botz and profiles.

var_name

The name of the variable to plot (must be a colname in profile$profiles). Default `"Chl_a_sum"`. If `profile_obj` contains only one variable, var_name is ignored and the content of the profile is shown.

target_date

The target date or date-time to plot. Can be a `Date`, `POSIXct`, character string, or a vector such as `c(year, month, day)`.

p

The handle of an existing figure, if you don't want to create a new figure

colour

Line colour for the plotted profile.

profileObj

Deprecated compatibility alias for `profile_obj`.

Value

the handle of a figure containing the vertical profile plot

Examples

if (FALSE) { # \dontrun{
plot_ereefs_profile(get_ereefs_profile("TN"))
} # }