biomod2: BIOMOD.models.out-methods – R documentation

Pricing

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Get Started for Free

Documentation

biomod2

BIOMOD.models.out-methods

BIOMOD.models.out getters

Description

Functions to get attributes of BIOMOD_Modeling outputs

Usage

get_predictions(obj, ...)
  get_formal_data(obj, ...)
  get_evaluations(obj, ...)
  get_calib_lines(obj, ...)
  get_variables_importance(obj, ...)
  get_options(obj, ...)
  get_built_models(obj, ...)

Arguments

`obj`	`"BIOMOD.models.out"` object
`...`	extra arguments (see details)

Details

... available values :

get_evaluations
- as.data.frame:"logical", ( FALSE by default ) if TRUE, a standardized data.frame will be produced else a 4-dimension array is returned
get_calib_lines
get_predictions (for BIOMOD_Modeling() outputs only)
- as.data.frame:logical(default FALSE). If TRUE, models predictions will be returned as data.frame rather than array
- evaluation:logical (default FALSE). If TRUE, model prediction over evaluation data will be returned
get_formal_data
- subinfo:character. Flag defining a specific information to extract from "BIOMOD.formated.data" object. Supported values are:
  - NULL: (default) the whole "BIOMOD.formated.data" object is returned
  - 'MinMax': All explanatory variables ranges returned
  - 'resp.var': Response variables vector returned
  - 'eval.resp.var': Evaluation response variables vector returned
  - 'expl.var': Explanatory variables data.frame returned
  - 'eval.expl.var': Evaluation explanatory variables data.frame returned
  - 'expl.var.names': Explanatory variables names returned

Value

get_predictions: an array (or a data.frame) containing models predictions over calibrating and testing data (those used for evaluate models)
get_calib_lines: an array (or a data.frame) having the same dimension than the output of get_predictions() of logical values. All lines containing TRUE have been used to calibrate the model
get_evaluations: an array, a data.frame or a list containing models evaluation scores
get_variables_importance: an array containing models variables importance
get_options: a "BIOMOD.Model.Options" reporting options used to build individual models
get_formal_data: a "BIOMOD.formated.data" object containing data used for models building and evaluation, or a part of this object
get_built_models: a character vector giving the names of models successfully computed

Author(s)

Wilfried Thuiller, Damien Georges