data_matrix {bigReg}

function to create a data_frame object

Description

function to create a data_matrix object. The data_matrix object is an object that is held on disk. It is written to a folder path on disk where the data is written to in blocks or chunks. The data is written in binary format using a C++ function in purely numerical data.

Usage

data_matrix(
  data = stop("data: matrix must be supplied"),
  chunkSize = stop("chunkSize must be specified, a good number is 50000"),
  path = stop("path must be specified"),
  nCores = parallel::detectCores(),
  ...
)

Arguments

data

object to be converted into a data_matrix object

chunkSize

number of rows to be used in each chunk

path

character to folder where the object will be created

nCores

the number of cores to use defaults to parallel::detectCores()

...

not used at the moment

Details

Creates a data_matrix object