msl.fileplot {TrendSLR} | R Documentation |
Plotting to file options in JPEG format.
Description
Plotting to file options in JPEG format.
Usage
msl.fileplot(x, resol = 1800, wdir = " ", file_name = " ",
type = 1, ci = 1, header = TRUE)
Arguments
x |
object of class “msl.trend” (see |
resol |
numeric, enables a user defined resolution in dpi from [300 to 1800] where 1800 is the default setting. |
wdir |
character string, providing the name of the directory to send output files (e.g., “C:/myproject/”). If this field is left blank the function will terminate with a warning message sent to the console. |
file_name |
is a character string indicating the name of the output file. There is no need to include the file extension *.jpeg. If this field is left blank the output file will be automatically saved in the defined directory (wdir) under the default name “Plot1.jpeg”. |
type |
numeric, enables a user defined input to select the type of chart to be plotted. 5 seperate options are available:
|
ci |
numeric, enables a user defined input to select the type of confidence interval to be displayed on the plots. The default setting (ci = 1) corresponds to a 95% confidence interval whilst ci = 2 provides a 99% confidence interval. |
header |
logical, if ‘TRUE’ then the station_name (if provided)
in the “msl.trend” (see |
Details
This function provides report quality JPEG format summary plots for both
“msl.trend” (see msl.trend
) and “custom.trend”
(see custom.trend
) objects. The same range of alternative screen
plotting options are available via msl.screenplot
.
See Also
msl.trend
, custom.trend
,
msl.screenplot
Examples
# Plot to file from "custom.trend" object
data(t) # "custom.trend" object
str(t) # check object
# -------------------------------------------------------------------------
# The following call to msl.fileplot can be found in the temporary
# directory under the file name "Plot1.jpeg".
# -------------------------------------------------------------------------
wd <- tempdir() # find temp directory
msl.fileplot(t, wdir = wd) # default screen plot output