RandomGammaArray-class {DelayedRandomArray} | R Documentation

## DelayedArray of random gamma-distributed values

### Description

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

### Usage

    RandomGammaArraySeed(dim, shape, rate = 1, scale = 1/rate, chunkdim = NULL)

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

    RandomGammaArray(dim, shape, rate = 1, scale = 1/rate, chunkdim = NULL)

### Arguments

`dim` | Integer vector of positive length, specifying the dimensions of the array.
`shape, rate, scale` | Numeric vector used as the argument of the same name in `qgamma`. Alternatively, a numeric array-like object with the same dimensions as `dim`. If `scale` is explicitly supplied, `rate` is ignored.
`chunkdim` | Integer vector of length equal to `dim`, containing the dimensions of each chunk.
`seed` | A RandomGammaArraySeed object.

### Value

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

### Author(s)

Aaron Lun

### See Also

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

### Examples

    X <- RandomGammaArraySeed(c(1e5, 1e5), shape=1, rate=10)
    Y <- DelayedArray(X)
    Y

    # Fiddling with the distribution parameters:
    X2 <- RandomGammaArraySeed(c(1e5, 1e5), shape=runif(1e5), rate=2)
    Y2 <- DelayedArray(X2)
    Y2

    # Using another array as input:
    library(Matrix)
    s1 <- rsparsematrix(1e5, 1e5, density=0.00001)
    s1 <- abs(DelayedArray(s1)) + 1
    X3 <- RandomGammaArraySeed(c(1e5, 1e5), shape=s1, rate=s1+1)
    Y3 <- DelayedArray(X3)
    Y3

[Package DelayedRandomArray version 1.0.0 Index]