MINI MINI MANI MO
%
% Copyright (c) 2012, 2014, Oracle and/or its affiliates. All rights reserved.
%
% NAME
% ore.frame-class.Rd - ore.frame Objects
%
% DESCRIPTION
% The ore.frame class represents data sets in an Oracle Database.
%
% NOTES
%
% MODIFIED (MM/DD/YY)
% demukhin 11/02/12 - bug 13620876: merge order
%
\name{ore.frame-class}
\docType{class}
\alias{ore.frame-class}
\alias{!,ore.frame-method}
\alias{$,ore.frame-method}
\alias{$<-,ore.frame-method}
\alias{Arith,number,ore.frame-method}
\alias{Arith,ore.date,ore.frame-method}
\alias{Arith,ore.datetime,ore.frame-method}
\alias{Arith,ore.difftime,ore.frame-method}
\alias{Arith,ore.frame,missing-method}
\alias{Arith,ore.frame,number-method}
\alias{Arith,ore.frame,ore.date-method}
\alias{Arith,ore.frame,ore.datetime-method}
\alias{Arith,ore.frame,ore.difftime-method}
\alias{Arith,ore.frame,ore.frame-method}
\alias{Arith,ore.frame,ore.number-method}
\alias{Arith,ore.number,ore.frame-method}
\alias{Compare,ANY,ore.frame-method}
\alias{Compare,ore.frame,ANY-method}
\alias{Compare,ore.frame,ore.frame-method}
\alias{Compare,ore.frame,ore.vector-method}
\alias{Compare,ore.vector,ore.frame-method}
\alias{Logic,ore.frame,ore.frame-method}
\alias{Logic,ore.frame,ore.number-method}
\alias{Logic,ore.frame,number-method}
\alias{Logic,ore.number,ore.frame-method}
\alias{Logic,number,ore.frame-method}
\alias{Math,ore.frame-method}
\alias{NCOL,ore.frame-method}
\alias{NROW,ore.frame-method}
\alias{Summary,ore.frame-method}
\alias{[,ore.frame,ANY,ANY-method}
\alias{[,ore.frame,ANY,missing-method}
\alias{[,ore.frame,logical,missing-method}
\alias{[,ore.frame,missing,ANY-method}
\alias{[,ore.frame,missing,missing-method}
\alias{[,ore.frame,ore.logical,missing-method}
\alias{[,ore.frame,character,missing-method}
\alias{[,ore.frame,numeric,missing-method}
\alias{[,ore.frame,ore.character,missing-method}
\alias{[,ore.frame,ore.number,missing-method}
\alias{[<-,ore.frame,ANY,missing-method}
\alias{[<-,ore.frame,missing,ANY-method}
\alias{[<-,ore.frame,missing,missing-method}
\alias{[<-,ore.frame,ore.logical,ANY-method}
\alias{[<-,ore.frame,ore.logical,missing-method}
\alias{[[,ore.frame,character,missing-method}
\alias{[[,ore.frame,logical,missing-method}
\alias{[[,ore.frame,numeric,missing-method}
\alias{[[<-,ore.frame,character,missing-method}
\alias{[[<-,ore.frame,logical,missing-method}
\alias{[[<-,ore.frame,numeric,missing-method}
\alias{as.data.frame,list-method}
\alias{as.data.frame,ore.frame-method}
\alias{as.env}
\alias{as.env,ore.frame-method}
\alias{as.list,ore.frame-method}
\alias{as.matrix,ore.frame-method}
\alias{attach,ore.frame-method}
\alias{by,ore.frame-method}
\alias{cbind}
\alias{cbind,ore-method}
\alias{colMeans,ore.frame-method}
\alias{colSums,ore.frame-method}
\alias{colnames,ore.frame-method}
\alias{colnames<-,ore.frame-method}
\alias{row.names,ore.frame-method}
\alias{row.names<-,ore.frame-method}
\alias{rownames,ore.frame-method}
\alias{rownames<-,ore.frame-method}
\alias{data.frame}
\alias{data.frame,ore-method}
\alias{dim,ore.frame-method}
\alias{dimnames,ore.frame-method}
\alias{eval}
\alias{eval,expressionORlanguage,ore.frame-method}
\alias{head,ore.frame-method}
\alias{interaction,ore.frame-method}
\alias{is.finite,ore.frame-method}
\alias{is.infinite,ore.frame-method}
\alias{is.na,ore.frame-method}
\alias{is.nan,ore.frame-method}
\alias{length,ore.frame-method}
\alias{log,ore.frame-method}
\alias{logb,ore.frame-method}
\alias{max.col,ore.frame-method}
\alias{merge,data.frame,ore.frame-method}
\alias{merge,ore.frame,data.frame-method}
\alias{merge,ore.frame,ore.frame-method}
\alias{names,ore.frame-method}
\alias{names<-,ore.frame-method}
\alias{ncol,ore.frame-method}
\alias{nrow,ore.frame-method}
\alias{ore.frame}
\alias{rbind}
\alias{rbind,ore-method}
\alias{rbind,ore.frame-method}
\alias{round,ore.frame-method}
\alias{rowMeans,ore.frame-method}
\alias{rowSums,ore.frame-method}
\alias{scale,ore.frame-method}
\alias{show,ore.frame-method}
\alias{split,ore.frame-method}
\alias{subset,ore.frame-method}
\alias{summary,ore.frame-method}
\alias{tail,ore.frame-method}
\alias{transform,ore.frame-method}
\alias{unique,ore.frame-method}
\alias{unlist,ore.frame-method}
\alias{with,ore.frame-method}
\alias{within,ore.frame-method}
\alias{xor,ore.frame,ore.frame-method}
\alias{xor,ore.frame,ore.number-method}
\alias{xor,ore.frame,number-method}
\alias{xor,ore.number,ore.frame-method}
\alias{xor,number,ore.frame-method}
\title{
Klasse \code{ore.frame}
}
\description{
Die Klasse \code{ore.frame} stellt Datasets in Oracle R Enterprise dar.
}
\section{Accessors}{
In the code snippets below, argument \code{x} is an \code{ore.frame}
object.
\describe{
\item{}{
\code{\link[base]{nrow}(x)}, \code{\link[base]{ncol}(x)}:
Returns the number of rows and columns, respectively.
}
\item{}{
\code{\link[base]{NROW}(x)}, \code{\link[base]{NCOL}(x)}:
Same as \code{nrow(x)} and \code{ncol(x)}, respectively.
}
\item{}{
\code{\link[base]{dim}(x)}:
Returns an \code{\link[base]{integer}} vector defined as
\code{c(nrow(x), ncol(x))}.
}
\item{}{
\code{\link[base]{length}(x)}:
Returns the number of columns.
}
\item{}{
\code{\link[base]{colnames}(x)}, \code{\link[base]{names}(x)}:
Returns a \code{\link[base]{character}} vector containing the
column names.
}
\item{}{
\code{colnames(x) <- value}, \code{names(x) <- value}:
Replaces the column names in argument \code{x} with the names in
argument \code{value}.
}
\item{}{
\code{\link[base]{rownames}(x)}, \code{\link[base]{row.names}(x)}:
Returns an \code{\linkS4class{ore.character}} object containing
the row names. When the row names are made of multiple components,
they will be separated with the value specified in the
\code{ore.sep} option, which by default is set to \code{"|"}.
}
\item{}{
\code{rownames(x) <- value}, \code{row.names(x) <- value}:
Replaces the row names in argument \code{x} with the names in
argument \code{value}. The \code{value} argument must be either
\code{NULL} to remove row names, an
\code{\linkS4class{ore.vector}} object for single component names,
or an \code{\linkS4class{ore.frame}} object for multiple component
names.
}
\item{}{
\code{\link[base]{dimnames}(x)}:
Returns a \code{\link{list}} object defined as
\code{list(NULL, colnames(x))}.
}
}
}
\section{Subsetting}{
In the code snippets below, argument \code{x} is an \code{ore.frame}
object. The vector selecting columns can be logical, numeric or
character. The behavior is similar to that of \code{data.frame} with
a few exceptions or rather extensions. When doing character subsetting
on an \code{ore.frame} with complex rownames only the first component
is used for subsetting. Subsetting on all components is not yet
supported.
\describe{
\item{}{
\code{x[i, j, drop=TRUE]}:
Returns a new \code{ore.frame} object made of the selected rows and
columns. For single column selection, the \code{drop} argument
specifies whether or not to return an
\code{\linkS4class{ore.vector}} object.
}
\item{}{
\code{x[j] <- value}, \code{x[, j] <- value}:
Replaces the specified columns in \code{x} with \code{value}. When
\code{value} is \code{NULL}, the specified columns are removed
from \code{x}.
}
\item{}{
\code{x[[i]]}, \code{x$name}:
Returns the selected column as an \code{\linkS4class{ore.vector}}
object.
}
\item{}{
\code{x[[i]] <- value}, \code{x$name <- value}:
Replaces the specified column in \code{x} with \code{value}. When
\code{value} is \code{NULL}, the column is removed from \code{x}.
}
\item{}{
\code{\link[utils]{head}(x, n = 6L)}:
If argument \code{n} is non-negative, returns the first \code{n}
rows of argument \code{x}.
If argument \code{n} is negative, returns all but the last
\code{abs(n)} rows of argument \code{x}.
}
\item{}{
\code{\link[utils]{tail}(x, n = 6L)}:
If argument \code{n} is non-negative, returns the last \code{n}
rows of argument \code{x}.
If \code{n} is negative, returns all but the first \code{abs(n)}
rows of argument \code{x}.
}
\item{}{
\code{\link[base]{subset}(x, subset, select, drop = FALSE)}:
Returns a new \code{ore.frame} object using:
\describe{
\item{subset}{A logical expression indicating rows to keep,
where missing values are taken as a logical \code{FALSE}
value.}
\item{select}{An expression indicating columns to keep.}
\item{drop}{Argument passed on to \code{[} indexing operator.}
}
}
\item{}{
\code{\link[base]{is.na}(x)}:
Returns an \code{ore.frame} object containing
\code{\link[base]{logical}} data columns that indicate which cells
contains missing values.
}
\item{}{
\code{\link[base]{is.finite}(x)}:
Returns an \code{ore.frame} object containing
\code{\link[base]{logical}} data columns that indicate which cells
contain finite numbers.
}
\item{}{
\code{\link[base]{is.infinite}(x)}:
Returns an \code{ore.frame} object containing
\code{\link[base]{logical}} data columns that indicate which cells
contain infinite values.
}
\item{}{
\code{\link[base]{is.nan}(x)}:
Returns an \code{ore.frame} object containing
\code{\link[base]{logical}} data columns that indicate which cells
contain a not-a-number value.
}
}
}
\section{Splitting and Combining}{
In the code snippets below, argument \code{x} is an \code{ore.frame}
object.
\describe{
\item{}{
\code{\link[base]{split}(x, f, drop = FALSE)}:
Splits argument \code{x} into a \code{\link[base]{list}} object,
according to argument \code{f}, dropping elements corresponding to
unrepresented levels if \code{drop} is \code{TRUE}.
}
\item{}{
\code{\link[base]{cbind}(...)}:
Returns a new \code{ore.frame} object by combining the columns
of the \code{ore.frame} objects in \code{...}.
}
\item{}{
\code{\link[base]{rbind}(...)}:
Returns a new \code{ore.frame} object by combining the rows of
the \code{ore.frame} objects in \code{...}.
}
\item{}{
\code{\link[base]{merge}(x, y, ...)}:
Merges two \code{ore.frame} objects \code{x} and \code{y}, with
arguments in \code{...} being the same as those allowed by the
base \code{\link[base]{merge}} function. It is allowed for either
arguments \code{x} or \code{y} to be a
\code{\link[base]{data.frame}} object. If both inputs are ordered
\code{ore.frame} objects, the result will also be an ordered
\code{ore.frame} object with a complex key made from \code{x} and
\code{y} keys. Otherwise, the result is unordered.
}
}
}
\section{Looping}{
In the code snippets below, argument \code{x} is an \code{ore.frame}
object.
\describe{
\item{}{
\code{\link[base]{by}(data, INDICES, FUN, ..., simplify = TRUE)}:
Apply argument \code{FUN} to each partitioning of argument
\code{data}, an \code{ore.frame} object, specified by the
\code{factor} (or \code{list} of \code{factor} objects)
argument \code{INDICES}.
}
}
}
\section{Utilities}{
In the code snippets below, argument \code{x} is an \code{ore.frame}
object.
\describe{
\item{}{
\code{\link[base]{unique}(x)}:
Returns a new \code{ore.frame} object that contains only the
distinct rows in argument \code{x}.
}
}
}
\section{Evaluation}{
\describe{
\item{}{
\code{\link[base]{eval}(expr, envir, enclos = parent.frame())}:
Converts the \code{ore.frame} object specified in argument
\code{envir} to an \code{\link[base]{environment}} using function
\code{as.env}, with argument \code{enclos} as its parent,
and then evaluates argument \code{expr} within that environment.
}
\item{}{
\code{\link[base]{with}(data, expr, \dots)}:
Equivalent to expression \code{eval(quote(expr), data, ...)}.
}
\item{}{
\code{\link[base]{within}(data, expr, \dots)}:
Similar to function \code{with}, except assignments made during
evaluation are taken as assignments into argument \code{data},
i.e., new symbols have their value appended to argument
\code{data}, and assigning new values to existing symbols results
in replacement.
}
\item{}{
\code{\link[base]{transform}(`_data`, \dots)}:
Similar to function \code{within}, except assignments are
specified as independent optional arguments instead as depended
evaluations within a single expression.
}
}
}
\section{Matrix Methods}{
\describe{
\item{}{
\code{\link[base]{colMeans}(x, na.rm = FALSE)}:
Returns an \code{\linkS4class{ore.number}} object containing the
column means of argument \code{x}.
}
\item{}{
\code{\link[base]{colSums}(x, na.rm = FALSE)}:
Returns an \code{\linkS4class{ore.number}} object containing the
column sums of argument \code{x}.
}
\item{}{
\code{\link[base]{rowMeans}(x, na.rm = FALSE)}:
Returns an \code{\linkS4class{ore.number}} object containing the
row means of argument \code{x}.
}
\item{}{
\code{\link[base]{rowSums}(x, na.rm = FALSE)}:
Returns an \code{\linkS4class{ore.number}} object containing the
row sums of argument \code{x}.
}
\item{}{
\code{\link[base]{scale}(x, center = TRUE, scale = TRUE)}:
Returns an \code{\linkS4class{ore.frame}} object containing the
possibly centered and scaled version of argument \code{x}.
}
\item{}{
\code{\link[base]{max.col}(m, ties.method = c("first", "last"))}:
Returns an \code{\linkS4class{ore.integer}} object containing the
column number of the maximum value for each row of argument
\code{m}.
}
}
}
\section{Group Generics}{
\code{ore.frame} objects have support for S4 group generic functionality:
\describe{
\item{\code{Arith}}{\code{"+"}, \code{"-"}, \code{"*"}, \code{"^"},
\code{"\%\%"}, \code{"\%/\%"}, \code{"/"}}
\item{\code{Compare}}{\code{"=="}, \code{">"}, \code{"<"}, \code{"!="},
\code{"<="}, \code{">="}}
\item{\code{Logic}}{\code{"&"}, \code{"|"}}
\item{\code{Ops}}{\code{"Arith"}, \code{"Compare"}, \code{"Logic"}}
\item{\code{Math}}{\code{"abs"}, \code{"sign"}, \code{"sqrt"},
\code{"ceiling"}, \code{"floor"}, \code{"trunc"}, \code{"cummax"},
\code{"cummin"}, \code{"cumprod"}, \code{"cumsum"}, \code{"log"},
\code{"log10"}, \code{"log2"}, \code{"log1p"}, \code{"acos"},
\code{"acosh"}, \code{"asin"}, \code{"asinh"}, \code{"atan"},
\code{"atanh"}, \code{"exp"}, \code{"expm1"}, \code{"cos"},
\code{"cosh"}, \code{"sin"}, \code{"sinh"}, \code{"tan"}, \code{"tanh"},
\code{"gamma"}, \code{"lgamma"}, \code{"digamma"}, \code{"trigamma"}}
\item{\code{Math2}}{\code{"round"}, \code{"signif"}}
\item{\code{Summary}}{\code{"max"}, \code{"min"}, \code{"range"},
\code{"prod"}, \code{"sum"}, \code{"any"}, \code{"all"}}
}
See \link[methods]{S4groupGeneric} for more details.
}
\section{Logical Methods}{
\describe{
\item{}{
\code{\link[base]{!}x}:
Returns an \code{ore.frame} object containing the logical
negation (NOT) of argument \code{x}.
}
\item{}{
\code{\link[base]{xor}(x, y)}:
Returns an \code{ore.frame} object containing the exclusive or
combination of arguments \code{x} and \code{y}.
}
}
}
\section{Coercion}{
In the code snippets below, argument \code{x} is an \code{ore.frame}
object.
\describe{
\item{}{
\code{as.env(x, enclos = parent.frame())}:
Returns an \code{\link[base]{environment}} object containing an
\code{\linkS4class{ore.vector}} for each column in argument
\code{x}.
}
\item{}{
\code{\link[base]{as.list}(x)}:
Returns a \code{\link[base]{list}} object containing an
\code{\linkS4class{ore.vector}} for each column in argument
\code{x}.
}
\item{}{
\code{\link[base]{as.matrix}(x)}:
Returns an \code{\linkS4class{ore.matrix}} object.
}
}
}
\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}
}
\note{
See the corresponding \R documentation for the functions listed above.
}
\seealso{
\code{\linkS4class{ore}},
\code{\linkS4class{ore.character}},
\code{\linkS4class{ore.datetime}},
\code{\linkS4class{ore.factor}},
\code{\linkS4class{ore.logical}},
\code{\linkS4class{ore.matrix}},
\code{\linkS4class{ore.number}},
\code{\linkS4class{ore.vector}}
}
\examples{
IRIS <- ore.push(iris)
head(IRIS)
summary(IRIS)
colMeans(IRIS[1:4])
}
\keyword{classes}
\keyword{ORE}
OHA YOOOO