pacu_options: Setting some options for the package

View source: R/pacu.R

pacu_optionsR Documentation

Setting some options for the package

Description

Set settings regarding messages and default behaviors of the package

Usage

pacu_options(
  suppress.warnings = FALSE,
  suppress.messages = FALSE,
  apportion.size.multiplier = 1,
  minimum.coverage.fraction = 0.5
)

Arguments

suppress.warnings

whether to suppress warning messages

suppress.messages

whether to suppress messages

apportion.size.multiplier

a multiplier used to determine the size of the apportioning polygons in the RITAS algorithm. A value of sqrt(2) will make polygons approximately the same size as the harvest polygons. Smaller values increase the resolution but also increase the computation time substantially.

minimum.coverage.fraction

The minimum area of an apportioning polygon that needs to be covered to conduct the apportioning operation.

Details

Set pacu options

Value

as a side effect it modifies the ‘pacu.options’ environment.

Examples

## Not run: 
names(pacu.options)
pacu_options(suppress.warnings = FALSE)
pacu.options$suppress.warnings

## End(Not run)

pacu documentation built on June 8, 2025, 10:44 a.m.