use fit_options() for .fit_options arg input

Author: mccarthy-m-g

NAMESPACE

@@ -15,6 +15,7 @@ export(calculate_shrinkage)
 export(calculate_stats)
 export(compare_psn_execute_results)
 export(compare_psn_proseval_results)
+export(fit_options)
 export(group_by_dose)
 export(group_by_time)
 export(install_default_literature_model)

R/run_eval.R

@@ -32,10 +32,8 @@
 #'   result from a call to [stats_summ_options()].
 #' @param .vpc_options Options for VPC simulations. This must be the result from
 #'   a call to [vpc_options()].
-#' @param .fit_options Options for controlling MAP Bayesian fit. E.g.
-#' `.map_options = list(control = list(reltol = 1e-04))` will perform a slightly
-#' coarser fit (but more stable) which can be useful in some case (default 
-#' `reltol = 1e-05`).
+#' @param .fit_options Options for controlling MAP Bayesian fit. This must be
+#'   the result from a call to [fit_options()].
 #' @param threads number of threads to divide computations on. Default is 1,
 #'   i.e. no parallel execution
 #' @param ruv residual error variability magnitude, specified as list.
@@ -67,7 +65,7 @@ run_eval <- function(
   incremental = FALSE,
   .stats_summ_options = stats_summ_options(),
   .vpc_options = vpc_options(),
-  .fit_options = list(),
+  .fit_options = fit_options(),
   threads = 1,
   progress = TRUE,
   verbose = TRUE
@@ -195,3 +193,26 @@ run_eval <- function(
   ## 5. Return results
   out
 }
+
+#' Options for controlling MAP Bayesian fit
+#'
+#' @param ... These dots are reserved for future extensibility and must be empty.
+#' @param reltol Relative convergence tolerance. `reltol = 1e-04` will perform a
+#'   slightly coarser but more stable fit, which can be useful in some case.
+#'
+#' @returns A list.
+#' @export
+fit_options <- function(
+    ...,
+    reltol = 1e-05
+) {
+  rlang::check_dots_empty()
+  out <- list(
+    control = list(
+      reltol = vctrs::vec_assert(
+        reltol, ptype = numeric(), size = 1L, arg = "reltol"
+      )
+    )
+  )
+  structure(out, class = "mipdeval_fit_options")
+}