cbindBM: cbind functionality for class "big.matrix"

Description Usage Arguments Details Value

Description

This is used to bind columns to big.matrix objects, with the new copy optionally filebacked

Usage

1
2
3
cbindBM(x, y, binding = "right", cols.x = NULL, cols.y = NULL, z = NULL,
  type = NULL, separated = NULL, backingfile = NULL, backingpath = NULL,
  descriptorfile = NULL, binarydescriptor = FALSE, shared = TRUE)

Arguments

x

A "big.matrix"

y

Columns to append, accepts "big.matrix" and "matrix" in addition to "numeric" and "integer" (e.g. "2.5", "1L")

binding

Binding location, "right" or "left"

cols.x

Possible subset of columns from the x object; could be numeric, named, or logical

cols.y

Possible subset of columns from the y object if a matrix type object otherwise ignored; could be numeric, named, or logical

z

Optional destinitation object (matrix or big.matrix); if not specified, a big.matrix will be created

type

preferably specified (e.g. "integer", "double", etc.)

separated

use separated column organization of the data instead of column-major organization; use with caution if the number of columns is large.

backingfile

the root name for the file(s) for the cache of x.

backingpath

the path to the directory containing the file backing cache

descriptorfile

the name of the file to hold the backingfile description, for subsequent use with attach.big.matrix; if NULL, the backingfile is used as the root part of the descriptor file name. The descriptor file is placed in the same directory as the backing files.

binarydescriptor

the flag to specify if the binary RDS format should be used for the backingfile description, for subsequent use with attach.big.matrix; if NULL of FALSE, the dput() file format is used.

shared

TRUE by default, and always TRUE if the big.matrix is file-backed. For a non-filebacked big.matrix, shared=FALSE uses non-shared memory, which can be more stable for large (say, >50 allocation can sometimes fail in such cases due to exhausted shared-memory resources in the system.

Details

This is simply a wrapper for "big.matrix" objects whereby a new "big.matrix" is initialized and subsequently filled with the submitted arguments (optionally filtered).

Value

a "big.matrix"


cdeterman/bigmemoryExt documentation built on May 13, 2019, 2:36 p.m.