RandomBinomArray-class: DelayedArray of random binomial values

In LTLA/DelayedRandomArray: Delayed Arrays of Random Values

DelayedArray of random binomial values

Description

A DelayedArray subclass that performs on-the-fly sampling of binomial-distributed values.

Usage

RandomBinomArraySeed(dim, size, prob, chunkdim = NULL, sparse = FALSE)

## S4 method for signature 'RandomBinomArraySeed'
DelayedArray(seed)

RandomBinomArray(dim, size, prob, chunkdim = NULL, sparse = FALSE)

Arguments

dim	Integer vector of positive length, specifying the dimensions of the array.
size, prob	Numeric vector used as the argument of the same name in qbinom. Alternatively, a numeric array-like object with the same dimensions as dim.
chunkdim	Integer vector of length equal to dim, containing the dimensions of each chunk.
sparse	Logical scalar indicating whether the sampled array should be treated as sparse.
seed	A RandomBinomArraySeed object.

Value

All constructors return an instance of a RandomBinomArray object, containing random draws from a binomial distribution with the specified parameters.

Author(s)

Aaron Lun

See Also

The RandomArraySeed class, for details on chunking and the distributional parameters.

Examples

X <- RandomBinomArraySeed(c(1e5, 1e5), size=10, prob=0.5)
Y <- DelayedArray(X)
Y

# Fiddling with the distribution parameters:
X2 <- RandomBinomArraySeed(c(1e5, 1e5), size=10, 
    prob=runif(1e5, 0, 0.1), sparse=TRUE)
Y2 <- DelayedArray(X2)
Y2

# Using another array as input:
library(Matrix)
size <- rsparsematrix(1e5, 1e5, density=0.00001)
size <- round(abs(DelayedArray(size)) * 10)
X3 <- RandomBinomArraySeed(c(1e5, 1e5), size=size, prob=0.5)
Y3 <- DelayedArray(X3)
Y3

LTLA/DelayedRandomArray documentation built on July 7, 2024, 12:39 p.m.