RandomPoisArray-class: DelayedArray of random Poisson values

Description Usage Arguments Value Author(s) See Also Examples

Description

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

Usage

1
2
3
4
5
6
RandomPoisArraySeed(dim, lambda, chunkdim = NULL, sparse = FALSE)

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

RandomPoisArray(dim, lambda, chunkdim = NULL, sparse = FALSE)

Arguments

dim

Integer vector of positive length, specifying the dimensions of the array.

lambda

Numeric vector used as lambda in qpois. 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 RandomPoisArraySeed object.

Value

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

Author(s)

Aaron Lun

See Also

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

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
X <- RandomPoisArraySeed(c(1e5, 1e5), lambda=2)
Y <- DelayedArray(X)
Y

# Fiddling with the distribution parameters:
X2 <- RandomPoisArraySeed(c(1e5, 1e5), lambda=runif(1e5), sparse=TRUE)
Y2 <- DelayedArray(X2)
Y2

# Using another array as input:
library(Matrix)
lambda <- rsparsematrix(1e5, 1e5, density=0.00001)
lambda <- abs(DelayedArray(lambda)) + 0.1
X3 <- RandomPoisArraySeed(c(1e5, 1e5), lambda=lambda)
Y3 <- DelayedArray(X3)
Y3

LTLA/DelayedRandomArray documentation built on Dec. 18, 2021, 3:40 a.m.