R/print.dsm.R

In DistanceDevelopment/dsm: Density Surface Modelling of Distance Sampling Data

#' Print a description of a density surface model object
#'
#' This method just gives a short description of the fitted model. Use the
#' [`summary.dsm`][summary.dsm] method for more information.
#'
#' @param x a model fitted by [`dsm`][dsm]
#' @param \dots unspecified and unused arguments for S3 consistency
#' @return `NULL`
#' @export
#' @author David L. Miller
#' @keywords utility
print.dsm <- function(x, ...){

  # the code here is chopped together from mgcv and mrds

  # if we fit a gamm then we should just grab the gam bit for this
  # but note that a gamm was used!
  gamm <- FALSE
  if("gamm" %in% class(x)){
    x<-x$gam
    gamm <- TRUE
  }

  ### General information
  cat("\nDensity surface model\n")
  cat("Response : ",as.character(x$formula)[2] , "\n")

  if(all(class(x$ddf)=="list")){
    cat("\nDetection functions : \n")
    for(i in seq_along(x$ddf)){
      cat(" ", i, "-", ddf.model.description(x$ddf[[i]]),"\n")
    }
    cat("\n")
  }else{
    cat("\nDetection function :", ddf.model.description(x$ddf),"\n")
  }

  cat("\nFormula: ",as.character(x$formula)[2],"~",
                    as.character(x$formula)[-c(1,2)],"\n")
  cat("\n")

  if(gamm){
    cat("Fitting engine: gamm\n")
  }else if(("glm" %in% class(x)) & !any(class(x)=="gam")){
    cat("Fitting engine: glm\n")
  }else{
    cat("Fitting engine: gam\n")
  }

  cat("\n")

  invisible()
}