SDMtune (version 0.1.0)

corVar: Print Correlated Variables

Description

Utility that prints the name of correlated variables and the relative correlation coefficient value.

Usage

corVar(bg, method = "spearman", cor_th = NULL, order = TRUE,
  remove_diagonal = TRUE)

Arguments

bg

'>SWD. Locations used to test the correlation between environmental variables.

method

character. The method used to compute the correlation matrix, default is "spearman".

cor_th

numeric. If provided it prints only the variables whose correlation coefficient is higher or lower than the given threshold, default is NULL.

order

logical, if TRUE the variable are ordered from the most to the less highly correlated, default is TRUE.

remove_diagonal

logical, if TRUE the values in the diagonal are, removed, default is TRUE.

Value

The name of the correlated variables.

Examples

# NOT RUN {
# Acquire environmental variables
files <- list.files(path = file.path(system.file(package = "dismo"), "ex"),
                    pattern = "grd", full.names = TRUE)
predictors <- raster::stack(files)

# Prepare background locations
bg_coords <- dismo::randomPoints(predictors, 10000)

# Create SWD object
bg <- prepareSWD(species = "Vultur gryphus", coords = bg_coords,
                 env = predictors, categorical = "biome")

# Get the correlation among all the environmental variables
corVar(bg, method = "spearman")

# Get the environmental variables that have a correlation greater or equal to
# the given threshold
corVar(bg, method = "pearson", cor_th = 0.8)
# }