tabs (version 0.1.1)

get_correction: Get and prepare correction

Description

Get and prepare a correction dataset

Usage

get_correction(
  correction = NULL,
  topo = NULL,
  curve = NULL,
  units = list(topo = "m", curve = c(names = "yr", value = "m"), correction = "mm/yr"),
  verbose = FALSE
)

Value

A SpatRaster or vector with corrrection values in a suitable format for the reconstruct function, including a value for each time step, defined by the curve.

Arguments

correction

SpatRaster. Correction value, vector, grid, or list of grids to account for spatial-(non-)explicit and temporal (non-)linear changes in the topography (e.g., uplift and subsidence rates, sedimentation and erosion ticknesses)

topo

SpatRaster. Topographic/Bathymetric model as SpatRaster or path to dataset. The topo projection is the reference for further outputs.

curve

SpatRaster. Curve value, vector, grid or list of grids indicating the relative altitude of a biogeographic system per time period compared to the present. A typical example is a sea level curve indicating the relative sea level position above or below sea level compared to the present.

units

numeric. Units of topo, curve and correction provided as a list (default: units=list(topo='m', curve=c(names='yr', value='m'), correction='mm/yr'))

verbose

boolean. FALSE: No messages are printed. TRUE: Standard verbose mode 2: Very verbose mode, displaying detailed information.

Author

Johannes De Groeve

See Also

correction

Examples

sporades <- sporades()
topo <- sporades$topo
correction <- sporades$correction
curve <- sporades$curve

cor <- get_correction(correction=correction,
                      topo=topo,
                      curve=curve)