MINI MINI MANI MO

%
% Copyright (c) 2012, 2014, Oracle and/or its affiliates. All rights reserved. 
%
\name{ore.predict-lm}
\alias{ore.predict-lm}
\alias{ore.predict,lm-method}
\title{Oracle R Enterprise Predictions Using \code{\link[stats]{lm}} Models}
\description{
  Oracle R Enterprise method for generating predictions using
  \code{\link[stats]{lm}} models.
}
\usage{
  \S4method{ore.predict}{lm}(object, newdata, se.fit = FALSE, scale = NULL, df = Inf,
            interval = c("none", "confidence", "prediction"),
            level = 0.95, na.action = na.pass, pred.var = NULL,
            weights = NULL, ...)
}
\arguments{
  \item{object}{An \code{\link[stats]{lm}} model object.}
  \item{newdata}{An \code{\link[OREbase:ore.frame-class]{ore.frame}}
    object.}
  \item{se.fit}{A logical indicating whether to return the standard
    errors for the predictions.}
  \item{scale}{The scale parameter for standard error of the predictions.}
  \item{df}{The degrees of freedom for the predictions when argument
    \code{scale} is not \code{NULL}.}
  \item{interval}{The type of interval to return, either \code{"none"},
    \code{"confidence"}, or \code{"prediction"}.}
  \item{level}{The level for argument \code{interval}.}
  \item{na.action}{The manner in which \code{NA} values are handled,
    either \code{na.omit} or \code{na.pass}.}
  \item{pred.var}{When argument \code{interval} is \code{"prediction"},
    the variance for a single observation.}
  \item{weights}{When argument \code{interval} is \code{"prediction"}
    and argument \code{pred.val} is \code{NULL} and
    \code{object$weights} is not \code{NULL}, the variance weights
    for the predictions as either an
    \code{\link[OREbase:ore.numeric-class]{ore.numeric}} object or a
      one-sided model \code{\link[stats]{formula}} referring to data
      within argument \code{newdata}.}
  \item{\dots}{Optional arguments.}
}
\value{
  When argument \code{se.fit} is \code{FALSE} and argument
  \code{interval} is \code{"none"}, returns an
  \code{\link[OREbase:ore.numeric-class]{ore.numeric}} object containing
  the predictions.

  Otherwise returns an
  \code{\link[OREbase:ore.frame-class]{ore.frame}} object with up to
  four columns: \code{"PRED"}, \code{"SE.PRED"} (when argument
  \code{se.fit} is \code{TRUE}), \code{"LOWER.CONF"} and
  \code{"UPPER.CONF"} (when argument \code{interval} is
  \code{"confidence"}), and \code{"LOWER.PRED"} and \code{"UPPER.PRED"}
  (when argument \code{interval} is \code{"prediction"}).
}
\references{
  \href{http://www.oracle.com/technetwork/database/database-technologies/r/r-enterprise/documentation/index.html}{Oracle R Enterprise}
}
\note{
  Use of date/time terms in this method will result in an error.  
}
\author{
  Oracle \email{oracle-r-enterprise@oracle.com}
}
\seealso{
  \code{\link{ore.predict}},
  \code{\link{ore.predict-glm}},
  \code{\link[stats]{predict.lm}}.
}
\examples{
irisModel <- lm(Sepal.Length ~ ., data = iris)
IRIS <- ore.push(iris)
IRISpred <- ore.predict(irisModel, IRIS, se.fit = TRUE,
                        interval = "prediction")
IRIS <- cbind(IRIS, IRISpred)
head(IRIS)
}
\keyword{models}
\keyword{regression}