R/coef.OEFPIL.R

In OEFPIL: Optimal Estimation of Function Parameters by Iterated Linearization

#' @name coef.OEFPIL
#' @title Extract model coefficients from OEFPIL
#' @description Function which extracts the estimated model coefficients from an object of class \code{"OEFPIL"}.
#'
#' @param object an object of class \code{"OEFPIL"} (a result of a call to \code{OEFPIL}).
#' @param ...    other arguments.
#'
#' @return A named vector of estimated model coefficients extracted from an \code{"OEFPIL"} object.
#'
#' @seealso \code{\link{OEFPIL}}
#'
#' @examples
#'
#' ##Creating a data file (using steam data from MASS library)
#' library(MASS)
#' steamdata <- steam
#' colnames(steamdata) <- c("x","y")
#' startsteam <- list(b1 = 5, b2 = 8, b3 = 200)
#' k <- nrow(steamdata)
#' CM <- diag(rep(0.1,2*k))
#'
#' ##Creating an OEFPIL object
#' st1 <- OEFPIL(steamdata, y ~ b1 * 10^(b2 * x/ (b3 + x)), startsteam, CM, useNLS = FALSE)
#'
#' ##Use of coef function
#' coef(st1)
#'
#' @method coef OEFPIL
#' @export
coef.OEFPIL <- function(object,...) {
  ## Function for extracting the estimated coefficients from OEFPIL object.

  l <- (length(object) - 8) / 3
  ## number of parameters

  output <- unlist(object[1:l])
  names(output) <- object$contents$names.of.parameters
  return(output)
}