-
Notifications
You must be signed in to change notification settings - Fork 31
/
plot_temp.Rd
38 lines (33 loc) · 1.16 KB
/
plot_temp.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot_temp.R
\name{plot_temp}
\alias{plot_temp}
\title{plot water temperatures from a GLM simulation}
\usage{
plot_temp(file = "output.nc", fig_path = FALSE, reference = "surface",
col_lim, ...)
}
\arguments{
\item{file}{a string with the path to the netcdf output from GLM}
\item{fig_path}{F if plot to screen, string path if save plot as .png}
\item{reference}{a string for 'surface' or 'bottom'}
\item{col_lim}{range for heatmap (in units of the variable)}
\item{...}{additional arguments passed to \code{par()}}
}
\note{
\code{plot_temp} calls \code{\link{plot_var}} specifically for the \code{var_name = 'temp'}.
\code{\link{plot_var}} uses the \code{\link[graphics]{layout}} function and so is restricted to a full page display.
}
\examples{
sim_folder <- run_example_sim(verbose = FALSE)
nc_file <- file.path(sim_folder, 'output.nc')
plot_temp(file = nc_file, fig_path = FALSE)
plot_temp(file = nc_file, fig_path = 'test_figure.png', height = 3, reference = 'surface')
}
\author{
Jordan S. Read, Luke A. Winslow
}
\seealso{
\code{\link{get_temp}}, \code{\link{plot_var}}
}
\keyword{methods}