dump2dir: dump2dir function

Description Usage Arguments Value See Also

Description

This function, when set by the gridfunction argument of setoutput, in turn called by the argument output.control of lgcpPredict facilitates the dumping of data to disk. Data is dumped to a netCDF file, simout.nc, stored in the directory specified by the user. If the directory does not exist, then it will be created. Since the requested data dumped to disk may be very large in a run of lgcpPredict, by default, the user is prompted as to whether to proceed with prediction, this can be turned off by setting the option forceSave=TRUE detailed here. To save space, or increase the number of simulations that can be stored for a fixed disk space the option to only save the last time point is also available (lastonly=TRUE, which is the default setting).

Usage

1
dump2dir(dirname, lastonly = TRUE, forceSave = FALSE)

Arguments

dirname

character vector of length 1 containing the name of the directory to create

lastonly

only save output from time T? (see ?lgcpPredict for definition of T)

forceSave

option to override display of menu

Value

object of class dump2dir

See Also

setoutput, \ GFinitialise, GFupdate, GFfinalise, GFreturnvalue


bentaylor1/lgcp documentation built on May 12, 2019, 2:09 p.m.