chunkedApply: Applies a Function on Each Row or Column of a File-Backed...
In BGData: A Suite of Packages for Analysis of Big Genomic Data

chunkedApply

R Documentation

Applies a Function on Each Row or Column of a File-Backed Matrix

Description

Similar to apply, but designed for file-backed matrices. The function brings chunks of an object into physical memory by taking subsets, and applies a function on either the rows or the columns of the chunks using an optimized version of apply. If nCores is greater than 1, the function will be applied in parallel using mclapply. In that case the subsets of the object are taken on the slaves.

Usage

chunkedApply(X, MARGIN, FUN, i = seq_len(nrow(X)),
  j = seq_len(ncol(X)), chunkSize = 5000L,
  nCores = getOption("mc.cores", 2L), verbose = FALSE, ...)

Arguments

`X`	A file-backed matrix, typically the genotypes of a `BGData` object.
`MARGIN`	The subscripts which the function will be applied over. 1 indicates rows, 2 indicates columns.
`FUN`	The function to be applied.
`i`	Indicates which rows of `X` should be used. Can be integer, boolean, or character. By default, all rows are used.
`j`	Indicates which columns of `X` should be used. Can be integer, boolean, or character. By default, all columns are used.
`chunkSize`	The number of rows or columns of `X` that are brought into physical memory for processing per core. If `NULL`, all elements in `i` or `j` are used. Defaults to 5000.
`nCores`	The number of cores (passed to `mclapply`). Defaults to the number of cores as detected by `detectCores`.
`verbose`	Whether progress updates will be posted. Defaults to `FALSE`.
`...`	Additional arguments to be passed to the `apply` like function.

Examples

# Restrict number of cores to 1 on Windows
if (.Platform$OS.type == "windows") {
    options(mc.cores = 1)
}

# Load example data
bg <- BGData:::loadExample()

# Compute standard deviation of columns
chunkedApply(X = geno(bg), MARGIN = 2, FUN = sd)

BGData documentation built on March 31, 2023, 6:57 p.m.