docs updating documentation

AparicioJohan · Aug 30, 2024 · 4a452fd · 4a452fd
1 parent c1b2a45
commit 4a452fd
Show file tree

Hide file tree

Showing 20 changed files with 50 additions and 64 deletions.
diff --git a/R/02_modeler.R b/R/02_modeler.R
@@ -14,7 +14,8 @@
 #' @param upper Numeric vector specifying the upper bounds for the parameters. Default is \code{Inf} for all parameters.
 #' @param initial_vals A data frame with columns \code{uid}, and the initial parameter values for each group id. Used for providing specific initial values per group id.
 #' @param fixed_params A data frame with columns \code{uid}, and the fixed parameter values for each group id. Used for fixing certain parameters during optimization.
-#' @param method A character vector specifying the optimization methods to be used. See \code{optimx} package for available methods. Default is \code{c("subplex", "pracmanm", "anms")}.
+#' @param method A character vector specifying the optimization methods to be used. Check `optimx::checkallsolvers()` for available methods.
+#' Default is \code{c("subplex", "pracmanm", "anms")}.
 #' @param return_method Logical. If \code{TRUE}, includes the optimization method used in the result. Default is \code{FALSE}.
 #' @param subset An optional vector with levels of `grp` to filter the data. Default is \code{NULL}, meaning all groups are used.
 #' @param add_zero Logical. If \code{TRUE}, adds a zero value to the series at the start. Default is \code{FALSE}.

diff --git a/R/05_comparison.R b/R/05_comparison.R
@@ -37,8 +37,7 @@ logLik.modeler <- function(object, ...) {
 #' @param k Numeric, the penalty per parameter to be used; the default k = 2 is
 #' the classical AIC.
 #' @author Johan Aparicio [aut]
-#' @return A tibble with columns giving lower and upper confidence limits for
-#' each parameter.
+#' @return A tibble with columns giving the corresponding AIC and BIC.
 #' @examples
 #' library(flexFitR)
 #' dt <- data.frame(X = 1:6, Y = c(12, 16, 44, 50, 95, 100))

diff --git a/docs/articles/canopy-model.html b/docs/articles/canopy-model.html
diff --git a/docs/articles/how_to_start.html b/docs/articles/how_to_start.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -6,7 +6,7 @@ articles:
   height-model: height-model.html
   how_to_start: how_to_start.html
   maturity-model: maturity-model.html
-last_built: 2024-08-30T16:48Z
+last_built: 2024-08-30T18:15Z
 urls:
   reference: https://apariciojohan.github.io/flexFitR/reference
   article: https://apariciojohan.github.io/flexFitR/articles
diff --git a/docs/reference/anova.modeler-1.png b/docs/reference/anova.modeler-1.png
diff --git a/docs/reference/anova.modeler.html b/docs/reference/anova.modeler.html
diff --git a/docs/reference/coef.modeler.html b/docs/reference/coef.modeler.html
diff --git a/docs/reference/confint.modeler.html b/docs/reference/confint.modeler.html