R/methods.R

In edsandorf/cmdlR: Choice Modeling in R

#' @importFrom stats coef
#' @export
stats::coef

#' S3 generic for coef
#'
#' @param object A model object of class 'cmdlr'
#' @param ... Other arguments passed to the function
#' 
#' @method coef cmdlr
#'
#' @export
coef.cmdlr <- function(object, ...) {
  return(
    get_param_free(object, ...)
  )
}

#' @importFrom stats nobs
#' @export
stats::nobs

#' S3 generic for nobs
#' 
#' A generic method for getting the number of observations based on the number
#' of rows in the matrix of gradient observations.
#' 
#' @param object A model object of class 'cmdlr'
#' @param use.fallback Should fallback methods be used to try to guess the
#' value?
#' @param ... Additional arguments passed
#' 
#' 
#' @export
nobs.cmdlr <- function(object, use.fallback = FALSE, ...) {
  return(
    nrow(get_gradient_obs(object, ...))
  )
}

#' Function for extracting number of individuals
#' 
#' A generic method for getting the number of individuals based on the lenght of
#' the vector of optimum values
#'
#' @param object A 'cmdlr' model object
#' @param ... Additional parameters passed to the function
#' 
#' @export
nid <- function(object, ...) {
  return(
    length(get_function_values(object, ...))
  )
}

#' A generic print function for printing a 'cmdlr' object
#' 
#' @param x A 'cmdlr' model object
#' @param ... Other parameters passed to 'cmdlr'
#'
#' @method print cmdlr
#'
#' @export
print.cmdlr <- function(x, ...) {
  cat("---------------------------------------------------------------------\n")
  cat_summary_info(x, ...)
  cat("\n\n")
  print(coef(x))
  cat("\n\n")
  cat("---------------------------------------------------------------------\n")
}





#' S3 Generic for printing choice shares
#' 
#' @param x An object of class choice_shares
#' @param ... Other parameters passed to print 
#' 
#' @export
# print.choice_shares <- function(x, ...) {
#   
# }