plot_temp: Deprecated. Plot water temperatures from a GLM simulation

View source: R/plot_temp.R

plot_tempR Documentation

Deprecated. Plot water temperatures from a GLM simulation

Description

Deprecated. Plot water temperatures from a GLM simulation

Usage

plot_temp(
  nc_file = "output.nc",
  fig_path = NULL,
  reference = "surface",
  legend.title = NULL,
  interval = 0.5,
  text.size = 12,
  show.legend = TRUE,
  legend.position = "right",
  plot.title = NULL
)

Arguments

nc_file

a string with the path to the netcdf output from GLM

fig_path

Default is NULL (only plots to screen). Enter string path to save as output file. File type can be anything supported by ggplot2:ggsave. See examples.

reference

String; 'surface' or 'bottom. Only used for heatmap plots.

legend.title

Vector string; Default ('NULL') will use variable and units from netcdf file

interval

Positive number indicating the depth interval in meters to interpolate output data. Must be less than max depth of lake. Default = 0.5 m.

text.size

Integer; Default is 12. Higher values will increase text size in plot.

show.legend

Logical; TRUE to show legend (default), FALSE to hide legend

legend.position

String; Legend position. Default is 'right'. Options: 'left','right','top','bottom'

plot.title

Vector string; Default is no title.

Note

plot_temp calls plot_var specifically for the var_name = 'temp'. plot_var uses the layout function and so is restricted to a full page display.

Author(s)

Jordan S. Read, Luke A. Winslow

See Also

get_temp, plot_var

Examples

nc_file <- system.file("extdata", "output/output.nc", package = "glmtools")
plot_temp(nc_file = nc_file, fig_path = NULL)

USGS-R/glmtools documentation built on March 26, 2024, 5:43 p.m.