Merge pull request #27 from gpw13/set_reml

Pass REML flag to `lme4::lmer()`
gpw13 · Oct 7, 2024 · e8e5d67 · e8e5d67
2 parents 5fb8417 + 01d6feb
commit e8e5d67
Show file tree

Hide file tree

Showing 40 changed files with 169 additions and 97 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -18,7 +18,7 @@ License: GPL-3
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.1.2
+RoxygenNote: 7.3.2
 URL: https://github.com/gpw13/augury
 BugReports: https://github.com/gpw13/augury/issues
 Depends: 

diff --git a/R/predict_lme4_wrappers.R b/R/predict_lme4_wrappers.R
@@ -7,6 +7,7 @@
 #' [predict_lme4()].
 #'
 #' @inherit predict_general_mdl params return
+#' @param REML Flag passed directly to lme4::lmer(). From `lme4` docs: "logical scalar - Should the estimates be chosen to optimize the REML criterion (as opposed to the log-likelihood)?"
 #'
 #' @export
 predict_lmer <- function(df,
@@ -36,7 +37,8 @@ predict_lmer <- function(df,
                          replace_obs = c("missing", "all", "none"),
                          error_correct = FALSE,
                          error_correct_cols = NULL,
-                         shift_trend = FALSE) {
+                         shift_trend = FALSE,
+                         REML = TRUE) {
   predict_lme4(df = df,
                model = lme4::lmer,
                formula = formula,
@@ -65,7 +67,8 @@ predict_lmer <- function(df,
                replace_obs = replace_obs,
                error_correct = error_correct,
                error_correct_cols = error_correct_cols,
-               shift_trend = shift_trend)
+               shift_trend = shift_trend,
+               REML = REML)
 }
 
 #' Use a generalized linear mixed-effects model to infill and project data

diff --git a/man/fit_aarr_model.Rd b/man/fit_aarr_model.Rd
diff --git a/man/fit_forecast_average_model.Rd b/man/fit_forecast_average_model.Rd
diff --git a/man/fit_forecast_model.Rd b/man/fit_forecast_model.Rd
diff --git a/man/fit_general_model.Rd b/man/fit_general_model.Rd
diff --git a/man/fit_inla_average_model.Rd b/man/fit_inla_average_model.Rd
diff --git a/man/fit_inla_model.Rd b/man/fit_inla_model.Rd
diff --git a/man/fit_lme4_model.Rd b/man/fit_lme4_model.Rd
diff --git a/man/forecast_series.Rd b/man/forecast_series.Rd
diff --git a/man/map_model_behavior.Rd b/man/map_model_behavior.Rd
diff --git a/man/merge_average_df.Rd b/man/merge_average_df.Rd
diff --git a/man/merge_prediction.Rd b/man/merge_prediction.Rd
diff --git a/man/predict_aarr.Rd b/man/predict_aarr.Rd
diff --git a/man/predict_average.Rd b/man/predict_average.Rd
diff --git a/man/predict_average_fn.Rd b/man/predict_average_fn.Rd