MINI MINI MANI MO

%
% Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
%
\name{ore.options}
\alias{ore.options}
\alias{ore.envAsEmptyenv}
\alias{ore.na.extract}
\alias{ore.parallel}
\alias{ore.sep}
\alias{ore.trace}
\alias{ore.warn.order}
\title{Oracle R Enterprise Global Options}
\description{
  The global options that affect Oracle R Enterprise operations.
}
\section{Options for Reporting}{
  \describe{
    \item{\code{ore.trace}:}{
      A logical value indicating whether iterative Oracle R Enterprise
      functions should print output at each iteration.
      The default value for this option is \code{FALSE}.
    }
  }
}
\section{Options for Row Ordering}{
  \describe{
    \item{\code{ore.sep}:}{
      A character string specifying the separator to use between multiple
      column row names of an \code{\linkS4class{ore.frame}}.
      The default value for this option is \code{"|"}.
    }
    \item{\code{ore.warn.order}:}{
      A logical value indicating whether a warning should be issued when
      pulling an \code{\linkS4class{ore.frame}} that lacks row names or
      an \code{\linkS4class{ore.vector}} that lacks element names into
      memory.
      The default value for this option is \code{TRUE}.
    }
  }
}
\section{Options for Server Execution}{
  \describe{
    \item{\code{ore.parallel}:}{
      A preferred degree of parallelism to use in the embedded R job;
      either
      a positive integer greater than or equal to \code{2} for a
      specific degree of parallelism,
      a value of \code{FALSE} or \code{1} for no parallelism, 
      a value of \code{TRUE} for the database's default for parallelism,
      or \code{NULL} for the database default for the operation.
      The default value for this option is \code{NULL}.
    }
  }
}
\section{Options for Subsetting}{
  \describe{
    \item{\code{ore.na.extract}:}{
      A logical value used during logical subscripting of an
      \code{\linkS4class{ore.frame}} or \code{\linkS4class{ore.vector}}
      object. When \code{TRUE} rows or elements with an \code{NA}
      logical subscript produces rows or elements with \code{NA}
      values. When \code{FALSE} an \code{NA} logical subscript is
      interpreted as a \code{FALSE} value, resulting in the removal of
      the corresponding row or element.
      The default value for this option is \code{FALSE}, whereas a value
      of \code{TRUE} would mimic how \R treats missing value logical
      subscripting of \code{data.frame} and \code{vector} objects.
    }
  }
}
\section{Options for Serialization}{
  \describe{
    \item{\code{ore.envAsEmptyenv}:}{
      A logical value indicating whether referenced environments
      in an object should be replaced with an empty environment during
      serialization to an Oracle Database. When \code{TRUE}, the
      referenced environment in the object will be replaced with an
      empty environment whose parent is \code{.GlobalEnv}, and
      therefore, the objects in the original referenced environment will
      not be serialized. In some situations, this could significantly
      reduce the size of serialized objects. When \code{FALSE}, all the
      objects in the referenced environment will be serialized, and
      could be unserialized and loaded into memory. The default value
      for this option is \code{FALSE}.

      Serialization is used across Oracle R Enterprise. It is used in
      \code{ore.save} before saving objects to a datastore. It is
      used in the method \code{ore.push} for a \code{list}, saving
      a serialized \code{list} object to the database. It is used as well in
      the embedded R functions for serializing parameters of \code{list}
      type and serializing some objects returned by an embedded R function.
    }
  }
}

\references{
  \href{http://www.oracle.com/technetwork/database/database-technologies/r/r-enterprise/documentation/index.html}{Oracle R Enterprise}
}
\author{
  Oracle \email{oracle-r-enterprise@oracle.com}
}
\seealso{
  \code{\link[base]{options}},
  \code{\link[OREembed]{ore.save}},
  \code{\link[OREembed]{ore.datastore}},
  \code{\link[OREembed]{ore.doEval}}
  
}
\examples{
options()[c("ore.envAsEmptyenv", "ore.na.extract", "ore.parallel", "ore.sep",
            "ore.trace", "ore.warn.order")] 
}
\keyword{environment}
\keyword{error}
\keyword{print}
\keyword{ORE}