getModelInfo: Get information/modelIDs relevant to fitted models in a...

In babaknaimi/sdm: Species Distribution Modelling

Get information/modelIDs relevant to fitted models in a sdmModels object

Description

When SDMs are fitted using the sdm function, a sdmModels object is generated containing all the information and objects created through fitting and evaluation procedures for all species and methods. To each model, a unique modelID is assigned. getModelInfo returns a data.frame summarising some information relevant to the fitted models including modelID, method name, whether the model is fitted successfully, whether and what replication procedure is used for data partitioning, etc. getModelInfo helps to get the unique model IDs for all or certain models given the parameters that users specify. getModelObject returns the fitted model object for a single model (specified through id, or other settings).

Usage

getModelId(x,success,species,method,replication, run)

getModelInfo(x,...)

getModelObject(x,id,species,method,replication, run)

Arguments

x	a sdmModel object
success	logical; specifies whether the info/ids should be returned only for the models that are successfully fitted or not (default is TRUE)
species	optional; a character vector specifies the name of species for which the info should be returned (default is NULL meaning for all species)
method	optional; a character vector specifies the name of methods for which the info should be returned (default is NULL meaning for all methods)
replication	optional; a character vector specifies the name of replication method for which the info should be returned (default is NULL meaning for all species)
run	optional; a numeric vector specifies for which replication runs the info should be returned (default is NULL meaning for all runs)
id	a single numeric value specifying the modelID
...	additional arguments. see details

Details

in getModelInfo, as additional arguments, you can use the arguments in the function getModelId to specify which records should be returned.

Value

getModelInfo: data.frame getModelId: a numeric vector getModelObject: The fitted model object with a class depending on the method

Author(s)

Babak Naimi [e-mail]

https://www.r-gis.net/

https://www.biogeoinformatics.org/

References

Naimi, B., Araujo, M.B. (2016) sdm: a reproducible and extensible R platform for species distribution modelling, Ecography, 39:368-375, DOI: 10.1111/ecog.01881

See Also

#

Examples

file <- system.file("external/model.sdm", package="sdm")

m <- read.sdm(file)

getModelInfo(m)

# getModelId(m)

# getModelId(m,method='brt')

obj <- getModelInfo(m, id=3) # obj is the fitted BRT model (through the package of gbm)

class(obj) # The class of the model object

summary(obj)

babaknaimi/sdm documentation built on April 4, 2024, 1:45 p.m.