effect_strength {hmer}

Find Effect Strength of Active Variables

Description

Collates the linear and quadratic contributions of the active variables to the global emulators' behaviour

Usage

effect_strength(
  ems,
  plt = interactive(),
  line.plot = FALSE,
  grid.plot = FALSE,
  labels = TRUE,
  quadratic = TRUE,
  xvar = TRUE
)

Arguments

ems

The Emulator object(s) to be analysed.

plt

Should the results be plotted?

line.plot

Should a line plot be produced?

grid.plot

Should the effect strengths be plotted as a grid?

labels

Whether or not the legend should be included.

quadratic

Whether or not quadratic effect strength should be calculated.

xvar

Should the inputs be used on the x-axis?

Details

For a set of emulators, it can be useful to see the relative contributions of various parameters to the global part of the emulator (i.e. the regression surface). This function extracts the relevant information from a list of emulator objects.

The parameter quadratic controls whether quadratic effect strength is calculated and plotted (an unnecessary plot if, say, linear emulators have been trained). The remaining options control visual aspects of the plots: line.plot determines whether a line or bar (default) plot should be produced, grid.plot determines whether the results are plotted as a graph or a grid, and labels determines if a legend should be provided with the plot (for large numbers of emulators, it is advisable to set this to FALSE).

Value

A list of data.frames: the first is the linear strength, and the second quadratic.

See Also

Other visualisation tools: behaviour_plot(), diagnostic_wrap(), emulator_plot(), hit_by_wave(), output_plot(), plot_actives(), plot_lattice(), plot_wrap(), simulator_plot(), space_removed(), validation_pairs(), wave_dependencies(), wave_points(), wave_values()

Examples

 effect <- effect_strength(SIREmulators$ems)
 effect_line <- effect_strength(SIREmulators$ems, line.plot = TRUE)
 effect_grid <- effect_strength(SIREmulators$ems, grid.plot = TRUE)