biascorrect: Bias correction of climate model output using KDDM.

In sethmcg/climod: Bias correction and other tools for climate model output

Description

This is the description of the function. It's the first full paragraph, and should briefly describe what the function does.

Usage

biascorrect(bcdata, norm = "zscore", minobs = 250, dmap = FALSE, ...)

Arguments

bcdata	The data to be bias-corrected. A list with elements named "obs", "cur", and "fut".
norm	The type of normalization to use. See normalize for more details.
minobs	The minimum number of data points to attempt a bias correction. If there are fewer that this many values in the observations or in the current period model output (e.g., for precipitation in a very dry location), the bias correction falls back on a simple scaling by the ratio of obs mean to cur mean. (If the ratio is undefined, future values are passed through unchanged.)
dmap	Logical; if TRUE, returns the distmap object generated during bias correction as an element named "dmap" in the returned list. N.B.: This option defaults to FALSE because the distmap object is significantly larger than the inputs and outputs of this function combined.
...	Arguments to pass to distmap.

Details

Third and subsequent paragraphs are details: a long section shown after the argument that goes into detail about how the function works.

Value

The return value of the function.

Examples

x <- "example code"
y <- "more example code"
paste(x, y)

sethmcg/climod documentation built on Nov. 19, 2021, 11:12 p.m.