matter_fct-class | R Documentation |
The matter_fct
class implements out-of-memory factors.
## Instance creation
matter_fct(data, levels, path = NULL,
length = NA_integer_, names = NULL, offset = 0, extent = NA_real_,
readonly = NA, append = FALSE, labels = as.character(levels), ...)
## Additional methods documented below
data |
An optional data vector which will be initially written to the data in virtual memory if provided. |
levels |
The levels of the factor. These should be of the same type as the data. (Use |
path |
A 'character' vector of the path(s) to the file(s) where the data are stored. If |
length |
The length of the factor. |
names |
The names of the data elements. |
offset |
A vector giving the offsets in number of bytes from the beginning of each file in 'path', specifying the start of the data to be accessed for each file. |
extent |
A vector giving the length of the data for each file in 'path', specifying the number of elements of size 'type' to be accessed from each file. |
readonly |
Whether the data and file(s) should be treated as read-only or read/write. |
append |
If |
labels |
An optional character vector of labels for the factor levels. |
... |
Additional arguments to be passed to constructor. |
An object of class matter_fct
.
data
:This slot stores any information necessary to access the data for the object (which may include the data itself and/or paths to file locations, etc.).
type
:The storage mode of the accessed data when read into R. This is a 'factor' with levels 'raw', 'logical', 'integer', 'numeric', or 'character'.
dim
:Either 'NULL' for vectors, or an integer vector of length one of more giving the maximal indices in each dimension for matrices and arrays.
names
:The names of the data elements for vectors.
dimnames
:Either 'NULL' or the names for the dimensions. If not 'NULL', then this should be a list of character vectors of the length given by 'dim' for each dimension. This is always 'NULL' for vectors.
levels
:The levels of the factor.
labels
:The labels for the levels.
matter
,
matter_vec
matter_fct
instances can be created through matter_fct()
or matter()
.
Standard generic methods:
length(x), length(x) <- value
:Get or set length.
names(x), names(x) <- value
:Get or set 'names'.
x[i], x[i] <- value
:Get or set the elements of the factor.
levels(x), levels(x) <- value
:Get or set the levels of the factor.
Kylie A. Bemis
matter
,
matter_vec
x <- matter_fct(rep(c("a", "a", "b"), 5), levels=c("a", "b", "c"))
x
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.