diff options
Diffstat (limited to 'R/parms.mkinfit.R')
| -rw-r--r-- | R/parms.mkinfit.R | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/R/parms.mkinfit.R b/R/parms.mkinfit.R index 0628cb92..281d06de 100644 --- a/R/parms.mkinfit.R +++ b/R/parms.mkinfit.R @@ -3,7 +3,7 @@ #' This function always returns degradation model parameters as well as error #' model parameters, in order to avoid working with a fitted model without #' considering the error structure that was assumed for the fit. -#' +#' #' @param object A fitted model object #' @param \dots Not used #' @return A numeric vector of fitted model parameters @@ -16,6 +16,10 @@ parms <- function(object, ...) #' @param transformed Should the parameters be returned #' as used internally during the optimisation? #' @rdname parms +#' @examples +#' fit <- mkinfit("SFO", FOCUS_2006_C) +#' parms(fit) +#' parms(fit, transformed = TRUE) #' @export parms.mkinfit <- function(object, transformed = FALSE, ...) { |