symDMatrix (version 2.1.1)

as.symDMatrix.matrix: Coerce a Matrix to a symDMatrix Object

Description

This function creates a symDMatrix from a numeric matrix that is assumed to be symmetric.

Usage

# S3 method for matrix
as.symDMatrix(x, blockSize = 5000L, vmode = "double",
  folderOut = randomString(), ...)

Arguments

x

A symmetric numeric matrix.

blockSize

The number of rows and columns of each block. If NULL, a single block of the same dimensions as x will be created. Defaults to 5000.

vmode

The vmode used to store the data in the ff objects.

folderOut

A name for a folder where to store the data of the resulting symDMatrix object.

...

Additional arguments (currently unused).

Value

A symDMatrix object.

Details

The input matrix is broken into blocks and each block is stored as an ff_matrix object. In addition, a metadata object called symDMatrix.RData is created to allow for easy reloading of the symDMatrix object.

See Also

load.symDMatrix to reload the symDMatrix object.