/
fit_gam.R
363 lines (331 loc) · 12.1 KB
/
fit_gam.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
#' Fit and validate Generalized Additive Models
#'
#' @param data data.frame. Database with response (0,1) and predictors values.
#' @param response character. Column name with species absence-presence data (0,1).
#' @param predictors character. Vector with the column names of quantitative
#' predictor variables (i.e. continuous variables).
#' Usage predictors = c("aet", "cwd", "tmin")
#' @param predictors_f character. Vector with the column names of qualitative
#' predictor variables (i.e. ordinal or nominal variables; factors). Usage predictors_f = c("landform")
#' @param select_pred logical. Perform predictor selection. Default FALSE.
#' @param partition character. Column name with training and validation partition groups.
#' @param thr character. Threshold used to get binary suitability values (i.e. 0,1). This is useful for threshold-dependent performance metrics. It is possible to use more than one threshold type. It is necessary to provide a vector for this argument. The following threshold criteria are available:
#' \itemize{
#' \item lpt: The highest threshold at which there is no omission.
#' \item equal_sens_spec: Threshold at which the sensitivity and specificity are equal.
#' \item max_sens_spec: Threshold at which the sum of the sensitivity and specificity is the highest (aka threshold that maximizes the TSS).
#' \item max_jaccard: The threshold at which the Jaccard index is the highest.
#' \item max_sorensen: The threshold at which the Sorensen index is highest.
#' \item max_fpb: The threshold at which FPB (F-measure on presence-background data) is highest.
#' \item sensitivity: Threshold based on a specified sensitivity value.
#' Usage thr = c('sensitivity', sens='0.6') or thr = c('sensitivity'). 'sens' refers to sensitivity value. If a sensitivity value is not specified, the default used is 0.9.
#' }
#' If more than one threshold type is used they must be concatenated, e.g., thr=c('lpt', 'max_sens_spec', 'max_jaccard'), or thr=c('lpt', 'max_sens_spec', 'sensitivity', sens='0.8'), or thr=c('lpt', 'max_sens_spec', 'sensitivity'). Function will use all threshold types if none is specified.
#' @param k integer. The dimension of the basis used to represent the smooth term. Default -1 (i.e., k=10). See
#' the help in ?mgcv::s.
#'
#' @param fit_formula formula. A formula object with response and predictor
#' variables (e.g. formula(pr_ab ~ aet + ppt_jja + pH + awc + depth + landform)).
#' Note that the variables used here must be consistent with those used in
#' response, predictors, and predictors_f arguments
#'
#' @return
#'
#' A list object with:
#' \itemize{
#' \item model: A "gam" class object from mgcv package. This object can be used for predicting.
#' \item predictors: A tibble with quantitative (c column names) and qualitative (f column names) variables use for modeling.
#' \item performance: Performance metric (see \code{\link{sdm_eval}}).
#' Threshold dependent metrics are calculated based on the threshold specified in the argument.
#' \item data_ens: Predicted suitability for each test partition. This database is used in \code{\link{fit_ensemble}}
#' }
#'
#' @details
#' This function fits GAM using mgvc package, with Binomial distribution family and thin plate regression spline as a smoothing basis (see ?mgvc::s).
#'
#' @seealso \code{\link{fit_gau}}, \code{\link{fit_gbm}}, \code{\link{fit_glm}},
#' \code{\link{fit_max}}, \code{\link{fit_net}}, \code{\link{fit_raf}}, and \code{\link{fit_svm}}.
#'
#' @export
#'
#' @importFrom dplyr bind_rows select all_of starts_with filter mutate tibble group_by summarise across relocate left_join
#' @importFrom mgcv gam predict.gam s
#' @importFrom stats complete.cases formula na.exclude sd
#'
#' @examples
#' \dontrun{
#' data("abies")
#'
#' # Using k-fold partition method
#' abies2 <- part_random(
#' data = abies,
#' pr_ab = "pr_ab",
#' method = c(method = "kfold", folds = 10)
#' )
#' abies2
#'
#' gam_t1 <- fit_gam(
#' data = abies2,
#' response = "pr_ab",
#' predictors = c("aet", "ppt_jja", "pH", "awc", "depth"),
#' predictors_f = c("landform"),
#' select_pred = FALSE,
#' partition = ".part",
#' thr = "max_sens_spec"
#' )
#' gam_t1$model
#' gam_t1$predictors
#' gam_t1$performance
#'
#' # Specifying the formula explicitly
#' require(mgcv)
#' gam_t2 <- fit_gam(
#' data = abies2,
#' response = "pr_ab",
#' predictors = c("aet", "ppt_jja", "pH", "awc", "depth"),
#' predictors_f = c("landform"),
#' select_pred = FALSE,
#' partition = ".part",
#' thr = "max_sens_spec",
#' fit_formula = stats::formula(pr_ab ~ s(aet) +
#' s(ppt_jja) +
#' s(pH) + landform)
#' )
#'
#' gam_t2$model
#' gam_t2$predictors
#' gam_t2$performance %>% dplyr::select(ends_with("_mean"))
#'
#' # Using repeated k-fold partition method
#' abies2 <- part_random(
#' data = abies,
#' pr_ab = "pr_ab",
#' method = c(method = "rep_kfold", folds = 5, replicates = 5)
#' )
#' abies2
#'
#' gam_t3 <- fit_gam(
#' data = abies2,
#' response = "pr_ab",
#' predictors = c("ppt_jja", "pH", "awc"),
#' predictors_f = c("landform"),
#' select_pred = FALSE,
#' partition = ".part",
#' thr = "max_sens_spec"
#' )
#' gam_t3
#' }
fit_gam <- function(data,
response,
predictors,
predictors_f = NULL,
select_pred = FALSE,
partition,
thr = NULL,
fit_formula = NULL,
k = -1) {
. <- model <- TPR <- IMAE <- rnames <- thr_value <- n_presences <- n_absences <- NULL
variables <- dplyr::bind_rows(c(c = predictors, f = predictors_f))
data <- data.frame(data)
if (is.null(predictors_f)) {
data <- data %>%
dplyr::select(dplyr::all_of(response), dplyr::all_of(predictors), dplyr::starts_with(partition))
data <- data.frame(data)
} else {
data <- data %>%
dplyr::select(dplyr::all_of(response), dplyr::all_of(predictors), dplyr::all_of(predictors_f), dplyr::starts_with(partition))
data <- data.frame(data)
for (i in predictors_f) {
data[, i] <- as.factor(data[, i])
}
}
# Remove NAs
complete_vec <- stats::complete.cases(data[, c(response, unlist(variables))])
if (sum(!complete_vec) > 0) {
message(sum(!complete_vec), " rows were excluded from database because NAs were found")
data <- data %>% dplyr::filter(complete_vec)
}
rm(complete_vec)
# Formula
if (is.null(fit_formula)) {
formula1 <-
paste(c(
paste("s(", predictors, paste0(", k = ", k, ")"), collapse = " + ", sep = ""),
predictors_f
), collapse = " + ")
formula1 <- stats::formula(paste(
response, "~", formula1
))
} else {
formula1 <- fit_formula
}
message(
"Formula used for model fitting:\n",
Reduce(paste, deparse(formula1)) %>% gsub(paste(" ", " ", collapse = "|"), " ", .),
"\n"
)
# Check amount of data and number of coefficients
# if (k < 0) {
# k <- 10
# }
ncoef <- n_coefficients(
data = data,
predictors = predictors,
predictors_f = predictors_f,
k = k
)
if (any(n_training(data = data, partition = partition) < ncoef)) {
message("\nModel has more coefficients than data used for training it. Try to reduce k")
return(NULL)
}
# Selection predictor
if (select_pred) {
message("Selecting predictors")
var_selected <- mgcv::gam(formula1, data = data, family = "binomial", select = TRUE, method = "REML")
var_selected <- summary(var_selected)$s.table %>% as.data.frame()
names(var_selected) <- c("est", "df", "z_val", "p_val")
var_selected <- rownames(var_selected)[var_selected$p_val <= 0.05]
var_selected <- gsub("[)]", "", gsub("[s(]", "", var_selected))
variables <- variables[variables %in% var_selected]
predictors <- predictors[predictors %in% var_selected]
predictors_f <- predictors_f[predictors_f %in% var_selected]
if(length(predictors_f)==0) {
predictors_f = NULL
}
formula1 <-
paste(c(
paste("s(", predictors, paste0(", k = ", k, ")"), collapse = " + ", sep = ""),
predictors_f
), collapse = " + ")
formula1 <- stats::formula(paste(
response, "~", formula1
))
message(
"Formula used for model fitting:\n",
Reduce(paste, deparse(formula1)) %>% gsub(paste(" ", " ", collapse = "|"), " ", .),
"\n"
)
}
# Fit models
np <- ncol(data %>% dplyr::select(dplyr::starts_with(partition)))
p_names <- names(data %>% dplyr::select(dplyr::starts_with(partition)))
eval_partial_list <- list()
pred_test_ens <- data %>%
dplyr::select(dplyr::starts_with(partition)) %>%
apply(., 2, unique) %>%
data.frame() %>%
as.list() %>%
lapply(., function(x) {
x <- stats::na.exclude(x)
x[!(x %in% c("train-test", "test"))] %>% as.list()
})
for (h in 1:np) {
message("Replica number: ", h, "/", np)
out <- pre_tr_te(data, p_names, h)
train <- out$train
test <- out$test
np2 <- out$np2
rm(out)
eval_partial <- as.list(rep(NA, np2))
pred_test <- list()
mod <- list()
for (i in 1:np2) {
message("Partition number: ", i, "/", np2)
tryCatch(
{
suppressWarnings(mod[[i]] <-
mgcv::gam(formula1,
data = train[[i]],
family = "binomial"
))
# Predict for presences absences data
if (!is.null(predictors_f)) {
for (fi in 1:length(predictors_f)) {
lev <- as.character(unique(mod[[i]]$xlevels[[predictors_f[fi]]]))
lev_filt <- test[[i]][, predictors_f[fi]] %in% lev
test[[i]] <- test[[i]][lev_filt, ]
}
}
pred_test <- data.frame(
pr_ab = test[[i]][, response],
pred = suppressWarnings(
mgcv::predict.gam(
mod[[i]],
newdata = test[[i]],
type = "response",
se.fit = FALSE
)
)
)
pred_test_ens[[h]][[i]] <- pred_test %>%
dplyr::mutate(rnames = rownames(test[[i]]))
# Validation of model
eval <-
sdm_eval(
p = pred_test$pred[pred_test$pr_ab == 1],
a = pred_test$pred[pred_test$pr_ab == 0],
thr = thr
)
eval_partial[[i]] <- dplyr::tibble(model = "gam", eval)
},
error = function(cond) {
message("Sorry, but it was not possible to fit the model with this data")
}
)
}
# Create final database with parameter performance
names(eval_partial) <- 1:np2
eval_partial <-
eval_partial[sapply(eval_partial, function(x) !is.null(dim(x)))] %>%
dplyr::bind_rows(., .id = "partition")
eval_partial_list[[h]] <- eval_partial
}
# Stop function for those cases wh
if (length(unique(eval_partial$partition)) < np2) {
# opt <- options(show.error.messages = FALSE)
# on.exit(options(opt))
return(NULL)
}
eval_partial <- eval_partial_list %>%
dplyr::bind_rows(., .id = "replica")
eval_final <- eval_partial %>%
dplyr::group_by(model, threshold) %>%
dplyr::summarise(dplyr::across(
TPR:IMAE,
list(mean = mean, sd = stats::sd)
), .groups = "drop")
# Bind data for ensemble
pred_test_ens <-
lapply(pred_test_ens, function(x) {
dplyr::bind_rows(x, .id = "part")
}) %>%
dplyr::bind_rows(., .id = "replicates") %>%
dplyr::tibble() %>%
dplyr::relocate(rnames)
# Fit final models with best settings
suppressWarnings(mod <-
mgcv::gam(formula1,
data = data,
family = "binomial"
))
pred_test <- data.frame(
pr_ab = data.frame(data)[,response],
pred = suppressMessages(mgcv::predict.gam(
mod,
newdata = data,
type = "response"
))
)
threshold <- sdm_eval(
p = pred_test$pred[pred_test$pr_ab == 1],
a = pred_test$pred[pred_test$pr_ab == 0],
thr = thr
)
result <- list(
model = mod,
predictors = variables,
performance = dplyr::left_join(eval_final, threshold[1:4], by = "threshold") %>% dplyr::relocate(model, threshold, thr_value, n_presences, n_absences),
data_ens = pred_test_ens
)
return(result)
}