Skip to contents

Remove existing priors from an existing distribution object

Source: R/add_priors.R
rm_priors.Rd

This function allows to remove priors from an existing distribution object. In order to remove a set prior, the name of the prior has to be specified.

Usage

rm_priors(x, names = NULL, ...)

# S4 method for class 'BiodiversityDistribution'
rm_priors(x, names = NULL, ...)

Arguments

x

distribution (i.e. BiodiversityDistribution) object.

names

A vector or character object for priors to be removed.

...

Other parameters passed down

See also

Other prior: BARTPrior(), BARTPriors(), BREGPrior(), BREGPriors(), GDBPrior(), GDBPriors(), GLMNETPrior(), GLMNETPriors(), INLAPrior(), INLAPriors(), STANPrior(), STANPriors(), XGBPrior(), XGBPriors(), add_priors(), get_priors(), priors()

Examples

if (FALSE) { # \dontrun{
 # Add prior
 pp <-  GLMNETPrior("forest")
 x <- distribution(background) |>
  add_priors(pp)
 # Remove again
 x <- x |> rm_priors("forest")
} # }