RandomLnormArray-class: DelayedArray of random log-normal values

In LTLA/DelayedRandomArray: Delayed Arrays of Random Values

DelayedArray of random log-normal values

Description

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

Usage

RandomLnormArraySeed(dim, meanlog = 0, sdlog = 1, chunkdim = NULL)

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

RandomLnormArray(dim, meanlog = 0, sdlog = 1, chunkdim = NULL)

Arguments

dim	Integer vector of positive length, specifying the dimensions of the array.
meanlog, sdlog	Numeric vector used as the argument of the same name in qlnorm. 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.
seed	A RandomLnormArraySeed object.

Value

All constructors return an instance of a RandomLnormArray object, containing random draws from a log-normal distribution with the specified parameters.

Author(s)

Aaron Lun

See Also

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

Examples

X <- RandomLnormArraySeed(c(1e5, 1e5))
Y <- DelayedArray(X)
Y

# Fiddling with the distribution parameters:
X2 <- RandomLnormArraySeed(c(1e5, 1e5), meanlog=runif(1e5), sdlog=runif(1e5))
Y2 <- DelayedArray(X2)
Y2

# Using another array as input:
library(Matrix)
meanlog <- rsparsematrix(1e5, 1e5, density=0.00001)
X3 <- RandomLnormArraySeed(c(1e5, 1e5), meanlog=meanlog)
Y3 <- DelayedArray(X3)
Y3

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