Skip to contents

Conditional effects of a FINN model

Source: R/xAI.R
conditionalEffects.Rd

Computes (and caches on the model) the conditional effects — the local derivatives of each demographic process (growth, mortality, regeneration) with respect to its inputs, per process and per species. This is the shared primitive behind ALE(), averageConditionalEffects() and the analytical variable importance in summary.finn_class().

Usage

conditionalEffects(
  model,
  env = NULL,
  init_cohort = NULL,
  env_autoscale = TRUE,
  sim_seed = 42L
)

Arguments

model

(finn_class)
fitted model.

env

(data.table|data.frame|NULL)
env covariates; NULL uses the cached training env.

init_cohort

(CohortMat|NULL)
initial cohort; NULL uses the cached training init_cohort.

env_autoscale

(logical(1))
see ALE().

sim_seed

(integer(1))
seed for the state-harvesting simulation (see ALE()).

Value

an object of class FINNconditionalEffects (also cached on model$conditional_effects).