writeEot: Write Eot* objects to disk

In environmentalinformatics-marburg/remote: Empirical Orthogonal Teleconnections in R

Write Eot* objects to disk

Description

Write Eot* objects to disk. This is merely a wrapper around raster::writeRaster() so see respective help section for details.

Usage

## S4 method for signature 'EotMode'
writeEot(x, path.out = ".", prefix = "remote", overwrite = TRUE, ...)

## S4 method for signature 'EotStack'
writeEot(x, path.out = ".", prefix, ...)

Arguments

x	an Eot* object
path.out	the path to the folder to write the files to
prefix	a prefix to be added to the file names (see Details)
overwrite	see raster::writeRaster(). Defaults to TRUE in writeEot()
...	further arguments passed to raster::writeRaster()

Details

writeEot() will write the results of either an EotMode or an EotStack to disk. For each mode the following files will be written:

• pred_r - the RasterLayer of the correlation coefficients between the base point and each pixel of the predictor domain

• pred_rsq - as above but for the coefficient of determination

• pred_rsq_sums - as above but for the sums of coefficient of determination

• pred_int - the RasterLayer of the intercept of the regression equation for each pixel of the predictor domain

• pred_slp - same as above but for the slope of the regression equation for each pixel of the predictor domain

• pred_p - the RasterLayer of the significance (p-value) of the the regression equation for each pixel of the predictor domain

• pred_resid - the RasterBrick of the reduced data for the predictor domain

Apart from pred_rsq_sums, all these files are also created for the response domain as resp_*. These will be pasted together with the prefix & the respective mode so that the file names will look like, e.g.:

prefix_mode_n_pred_r.grd

for the RasterLayer of the predictor correlation coefficient of mode n using the standard raster file type (.grd).

Methods (by class)

• writeEot(EotStack): EotStack

See Also

raster::writeRaster()

Examples

## Not run: 
data(vdendool)

nh_modes <- eot(x = vdendool, y = NULL, n = 2, 
                standardised = FALSE, 
                verbose = TRUE)

## write the complete EotStack
writeEot(nh_modes, prefix = "vdendool")

## write only one EotMode
writeEot(nh_modes[[2]], prefix = "vdendool")

## End(Not run)

environmentalinformatics-marburg/remote documentation built on June 12, 2025, 1:10 p.m.