R/format.bagEarth.R

In caret: Classification and Regression Training

#' Format 'bagEarth' objects
#' 
#' Return a string representing the \sQuote{bagEarth} expression.
#' 
#' 
#' @param x An \code{\link{bagEarth}} object.  This is the only required
#' argument.
#' @param file A connection, or a character string naming the file to print to.
#' If "" (the default), the output prints to the standard output connection.
#' See \code{\link[base]{cat}}.
#' @param cat a logical; should the equation be printed?
#' @param \dots Arguments to \code{\link[earth]{format.earth}}.
#' @return A character representation of the bagged earth object.
#' @seealso \code{\link[earth]{earth}}
#' @keywords models
#' @examples
#' 
#' a <- bagEarth(Volume ~ ., data = trees, B= 3)
#' format(a)
#' 
#' # yields:
#' # (
#' #   31.61075 
#' #   +  6.587273 * pmax(0,  Girth -   14.2) 
#' #   -  3.229363 * pmax(0,   14.2 -  Girth) 
#' #   - 0.3167140 * pmax(0,     79 - Height) 
#' #   +
#' #    22.80225 
#' #   +  5.309866 * pmax(0,  Girth -     12) 
#' #   -  2.378658 * pmax(0,     12 -  Girth) 
#' #   +  0.793045 * pmax(0, Height -     80) 
#' #   - 0.3411915 * pmax(0,     80 - Height) 
#' #   +
#' #    31.39772 
#' #   +   6.18193 * pmax(0,  Girth -   14.2) 
#' #   -  3.660456 * pmax(0,   14.2 -  Girth) 
#' #   + 0.6489774 * pmax(0, Height -     80) 
#' # )/3
#' 
#' @export
format.bagEarth <- function(x, file = "", cat = TRUE, ...) 
{
  requireNamespaceQuietStop("earth")

  eachEq <- lapply(
                   x$fit,
                   function(u, ...) format(u, ...),
                   ...)
  allEq <- paste(
                 "(",
                 paste(eachEq, collapse = "+"),
                 ") /",
                 x$B,
                 "\n")
  
  if(cat) cat(allEq, file = file) else return(allEq)  
}