BlockwiseData
objects.These functions implement basic operations on BlockwiseData
objects.
Blockwise here means
that the data is too large to be loaded or processed in one piece and is therefore split into blocks that can
be handled one by one in a divide-and-conquer manner.
BD.actualFileNames(bwData)
BD.nBlocks(bwData)
BD.blockLengths(bwData)
BD.getMetaData(bwData, blocks = NULL, simplify = TRUE)
BD.getData(bwData, blocks = NULL, simplify = TRUE)
BD.checkAndDeleteFiles(bwData)
A BlockwiseData
object.
Optional vector of integers specifying the blocks on which to execute the operation.
Logical: if the blocks
argument above is of length 1, should the returned list be simplified by
removing the redundant outer list
structure?
returns a vector of character strings giving the file names in which the files are
saved, or NULL
if the data are held in-memory.
returns the number of blocks in the input object.
returns the block lengths (results of applying length
to the data in
each block).
returns a list with one component per block. Each component is in turn a list
containing the stored meta-data for the corresponding block. If blocks
is of length 1 and
simplify
is TRUE
, the outer (redundant) list
is removed.
returns a list with one component per block. Each component is in turn a list
containing the stored data for the corresponding block. If blocks
is of length 1 and
simplify
is TRUE
, the outer (redundant) list
is removed.
deletes the files referenced in the input bwData
if they exist.
The definition of BlockwiseData
and the functions here
should be considered experimental and may change in
the future.
Several functions in this package use the concept of blockwise, or "divide-and-conquer", analysis. The BlockwiseData class is meant to hold the blockwise data, or all necessary information about blockwise data that is saved in disk files.
Definition of and other functions on BlockwiseData
:
newBlockwiseData
for creating new BlockwiseData
objects;
mergeBlockwiseData
for merging blockwise data structure;
addBlockToBlockwiseData
for adding a new block to existing blockwise data;