Skip to content

Commit

Permalink
docs updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
AparicioJohan committed Sep 7, 2024
1 parent 634670a commit 407e51d
Show file tree
Hide file tree
Showing 22 changed files with 121 additions and 166 deletions.
4 changes: 2 additions & 2 deletions R/02_modeler.R
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@
#' \describe{
#' \item{\code{param}}{A data frame containing the optimized parameters and related information.}
#' \item{\code{dt}}{A data frame with data used and fitted values.}
#' \item{\code{fn}}{The call used to calculate the AUC.}
#' \item{\code{fn}}{The call used when fitting models.}
#' \item{\code{metrics}}{Metrics and summary of the models.}
#' \item{\code{execution}}{Execution time.}
#' \item{\code{response}}{Response variable.}
#' \item{\code{keep}}{Metadata to keep across.}
#' \item{\code{fun}}{Function being optimized}
#' \item{\code{fun}}{Name of the function.}
#' \item{\code{fit}}{List with the fitted models.}
#' }
#' @export
Expand Down
5 changes: 3 additions & 2 deletions R/04_predict.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
#' @param object An object inheriting from class \code{modeler} resulting of
#' executing the function \code{modeler()}
#' @param x A numeric time point to make the prediction. Can be more than one.
#' If type = "auc", x needs to be of size 2, which specifies the interval for
#' calculating the AUC.
#' @param id A unique identifier to filter by. \code{NULL} by default.
#' @param type A character string specifying the type of prediction. If "point"
#' it will predict the value of y for a given x. If "auc" it will return the
Expand All @@ -16,12 +18,11 @@
#' @param ... Further parameters. For future improvements.
#' @author Johan Aparicio [aut]
#' @method predict modeler
#' @return A data.frame object with predicted values.
#' @return A data.frame object with predicted values and standard errors.
#' @export
#' @examples
#' library(flexFitR)
#' data(dt_potato)
#' explorer <- explorer(dt_potato, x = DAP, y = c(Canopy, GLI_2), id = Plot)
#' mod_1 <- dt_potato |>
#' modeler(
#' x = DAP,
Expand Down
2 changes: 1 addition & 1 deletion R/07_confint.R
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ confint.modeler <- function(x, parm = NULL, level = 0.95, id = NULL, ...) {
} else {
uid <- unique(dt$uid)
}
ci_table <- coef.modeler(x, df = TRUE, id = id) |>
ci_table <- coef.modeler(x, df = TRUE, id = uid) |>
mutate(
t_value = qt(1 - (1 - level) / 2, df = rdf),
ci_lower = solution - t_value * std.error,
Expand Down
25 changes: 4 additions & 21 deletions docs/articles/canopy-model.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 0 additions & 6 deletions docs/articles/height-model.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 12 additions & 12 deletions docs/articles/how_to_start.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 407e51d

Please sign in to comment.