| DataTable-API {IRanges} | R Documentation |
DataTable is an API only (i.e. virtual class with no slots) for accessing objects with a rectangular shape like DataFrame or RangedData objects. It mimics the API for standard data.frame objects.
In the following code snippets, x is a DataTable.
nrow(x), ncol(x):
Get the number of rows and columns, respectively.
NROW(x), NCOL(x):
Same as nrow(x) and ncol(x), respectively.
dim(x):
Length two integer vector defined as c(nrow(x), ncol(x)).
rownames(x), colnames(x):
Get the names of the rows and columns, respectively.
dimnames(x):
Length two list of character vectors defined as
list(rownames(x), colnames(x)).
In the code snippets below, x is a DataTable object.
x[i, j, drop=TRUE]:
Return a new DataTable object made of the selected rows and columns. For
single column selection, the drop argument specifies whether or not
to coerce the returned sequence to a standard vector.
head(x, n=6L):
If n is non-negative, returns the first n rows of the DataTable
object.
If n is negative, returns all but the last abs(n) rows of
the DataTable object.
tail(x, n=6L):
If n is non-negative, returns the last n rows of the DataTable
object.
If n is negative, returns all but the first abs(n) rows of
the DataTable object.
subset(x, subset, select, drop=FALSE):
Return a new DataTable object using:
logical expression indicating rows to keep, where missing values are taken as FALSE.
expression indicating columns to keep.
passed on to [ indexing operator.
na.omit(object):
Returns a subset with incomplete cases removed.
na.exclude(object):
Returns a subset with incomplete cases removed (but to be
included with NAs in statistical results).
is.na(x):
Returns a logical matrix indicating which cells are missing.
complete.cases(x):
Returns a logical vector identifying which cases have no missing values.
In the code snippets below, x is a DataTable object.
cbind(...): Creates a new DataTable by combining the columns
of the DataTable objects in ....
rbind(...): Creates a new DataTable by combining the rows of
the DataTable objects in ....
merge(x, y, ...): Merges two DataTable
objects x and y, with arguments in ... being
the same as those allowed by the base merge. It is
allowed for either x or y to be a data.frame.
In the code snippets below, x is a DataTable object.
aggregate(x, by, FUN, start = NULL, end = NULL, width = NULL,
frequency = NULL, delta = NULL, ..., simplify = TRUE):
Generates summaries on the specified windows and returns the result in a
convenient form:
byAn object with start, end, and
width methods.
FUNThe function, found via match.fun, to be
applied to each window of x.
start, end, widththe start, end, or width
of the window. If by is missing, then must supply two of the
three.
frequency, deltaOptional arguments that specify the sampling frequency and increment within the window.
Further arguments for FUN.
simplifyA logical value specifying whether or not the result should be simplified to a vector or matrix if possible.
by(data, INDICES, FUN, ..., simplify = TRUE):
Apply FUN to each group of data, a DataTable,
formed by the factor (or list of factors) INDICES. Exactly
the same contract as as.data.frame.
duplicated(x): Returns a logical vector indicating the rows
that are identical to a previous row.
unique(x): Returns a new DataTable after
removing the duplicated rows from x.
show(x):
By default the show method displays 5 head and 5 tail
lines. The number of lines can be altered by setting the global
options showHeadLines and showTailLines. If the
object length is less than the sum of the options, the full object
is displayed. These options affect GRanges, GAlignments,
Ranges, DataTable and XString objects.
as.env(x, enclos = parent.frame()):
Creates an environment from x with a symbol for each
colnames(x). The values are not actually copied into the
environment. Rather, they are dynamically bound using
makeActiveBinding. This prevents unnecessary copying
of the data from the external vectors into R vectors. The values
are cached, so that the data is not copied every time the symbol
is accessed.
DataTable-stats for statistical functionality, like fitting regression models, data.frame
showClass("DataTable") # shows (some of) the known subclasses