clamp_predictors

clamp_predictors.default

clamp_predictors.stars

clamp_predictors.SpatRaster

clamp_predictors.SpatRasterDataset

This function clamps the environmental variables in a <code><a href="/link/terra%3A%3ASpatRaster?package=tidysdm&version=1.0.0" data-mini-rdoc="tidysdm::terra::SpatRaster">terra::SpatRaster</a></code>
or <code><a href="/link/terra%3A%3ASpatRasterDataset?package=tidysdm&version=1.0.0" data-mini-rdoc="tidysdm::terra::SpatRasterDataset">terra::SpatRasterDataset</a></code> so that their minimum and maximum values do
not exceed the range in the training dataset.

extrapolation

Fit species distribution models (SDMs) using the 'tidymodels' framework,
which provides a standardised interface to define models and process their
outputs. 'tidysdm' expands 'tidymodels' by providing methods for spatial objects,
models and metrics specific to SDMs,
as well as a number of specialised functions to process occurrences
for contemporary and palaeo datasets. The full
functionalities of the package are described
in Leonardi et al. (2023) <doi:10.1101/2023.07.24.550358>.

Andrea Manica

tidysdm

Species Distribution Models with Tidymodels

Michela Leonardi

Margherita Colucci

Andrea Vittorio Pozzi

Eleanor M.L. Scerri

Ben Tupper

clamp_predictors function

<dl><dt>x</dt>
<dd>a <code><a href="/link/terra%3A%3ASpatRaster?package=tidysdm&version=1.0.0" data-mini-rdoc="tidysdm::terra::SpatRaster">terra::SpatRaster</a></code>, <code>stars</code> or <code><a href="/link/terra%3A%3ASpatRasterDataset?package=tidysdm&version=1.0.0" data-mini-rdoc="tidysdm::terra::SpatRasterDataset">terra::SpatRasterDataset</a></code> to
clamp.</dd>
<dt>training</dt>
<dd>the training dataset (a <code><a href="/link/data.frame?package=tidysdm&version=1.0.0" data-mini-rdoc="tidysdm::data.frame">data.frame</a></code> or a <code><a href="https://r-spatial.github.io/sf/reference/sf.html">sf::sf</a></code>
object.</dd>
<dt>.col</dt>
<dd>the column containing the presences (optional). If specified, it
is excluded from the clamping.</dd>
<dt>use_na</dt>
<dd>a boolean determining whether values outside the range of the
training dataset are removed (set to NA). If FALSE (the default), values
outside the training range are replaced with the extremes of the training
range.</dd>
<dt>...</dt>
<dd>additional arguments specific to a given object type</dd></dl>

Arguments

This function clamps the environmental variables in a <code><a href='https://rdrr.io/pkg/terra/man/SpatRaster-class.html'>terra::SpatRaster</a></code>
or <code><a href='https://rdrr.io/pkg/terra/man/SpatRaster-class.html'>terra::SpatRasterDataset</a></code> so that their minimum and maximum values do
not exceed the range in the training dataset.

Clamp the predictors to match values in training set — clamp_predictors

<dl>

<dt>x</dt>
<dd>a <code><a href='https://rdrr.io/pkg/terra/man/SpatRaster-class.html'>terra::SpatRaster</a></code>, <code>stars</code> or <code><a href='https://rdrr.io/pkg/terra/man/SpatRaster-class.html'>terra::SpatRasterDataset</a></code> to
clamp.</dd>


<dt>training</dt>
<dd>the training dataset (a <code><a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a></code> or a <code><a href='https://r-spatial.github.io/sf/reference/sf.html'>sf::sf</a></code>
object.</dd>


<dt>.col</dt>
<dd>the column containing the presences (optional). If specified, it
is excluded from the clamping.</dd>


<dt>use_na</dt>
<dd>a boolean determining whether values outside the range of the
training dataset are removed (set to NA). If FALSE (the default), values
outside the training range are replaced with the extremes of the training
range.</dd>


<dt>...</dt>
<dd>additional arguments specific to a given object type</dd>

</dl>

clamp_predictors: Clamp the predictors to match values in training set

Description

Usage

Value

Arguments