Simulate a spatial negative binomial random variable with a specific mean and covariance structure.
Usage
sprnbinom(
spcov_params,
dispersion = 1,
mean = 0,
samples = 1,
data,
randcov_params,
partition_factor,
...
)
Arguments
- spcov_params
An
spcov_params()
object.- dispersion
The dispersion value.
- mean
A numeric vector representing the mean.
mean
must have length 1 (in which case it is recycled) or length equal to the number of rows indata
. The default is0
.- samples
The number of independent samples to generate. The default is
1
.- data
A data frame or
sf
object containing spatial information.- randcov_params
A
randcov_params()
object.- partition_factor
A formula indicating the partition factor.
- ...
Additional arguments passed to
sprnorm()
.
Value
If samples
is 1, a vector of random variables for each row of data
is returned. If samples
is greater than one, a matrix of random variables
is returned, where the rows correspond to each row of data
and the columns
correspond to independent samples.
Details
The values of spcov_params
, mean
, and randcov_params
are assumed to be on the link scale. They are used to simulate a latent normal (Gaussian)
response variable using sprnorm()
. This latent variable is the
conditional mean used with dispersion
to simulate a negative binomial random variable.
Examples
spcov_params_val <- spcov_params("exponential", de = 0.2, ie = 0.1, range = 1)
sprnbinom(spcov_params_val, data = caribou, xcoord = x, ycoord = y)
#> [1] 1 0 0 0 0 0 2 0 1 0 0 4 0 0 4 0 1 1 0 2 4 4 0 0 0 1 0 4 0 0
sprnbinom(spcov_params_val, samples = 5, data = caribou, xcoord = x, ycoord = y)
#> 1 2 3 4 5
#> [1,] 1 2 0 4 1
#> [2,] 1 0 0 0 5
#> [3,] 4 0 1 2 6
#> [4,] 3 0 0 3 3
#> [5,] 0 1 1 1 0
#> [6,] 1 3 0 0 1
#> [7,] 0 0 0 2 0
#> [8,] 0 0 0 0 0
#> [9,] 1 1 2 0 1
#> [10,] 0 0 0 1 0
#> [11,] 0 0 2 0 1
#> [12,] 0 0 1 0 1
#> [13,] 1 0 1 0 0
#> [14,] 3 0 0 0 3
#> [15,] 0 5 0 0 0
#> [16,] 0 1 1 1 1
#> [17,] 0 1 0 3 0
#> [18,] 0 4 1 1 1
#> [19,] 1 0 2 3 2
#> [20,] 0 0 0 4 0
#> [21,] 0 0 3 4 2
#> [22,] 0 1 2 3 1
#> [23,] 0 1 0 0 0
#> [24,] 4 1 0 0 0
#> [25,] 0 0 3 0 1
#> [26,] 1 1 0 0 1
#> [27,] 0 1 0 0 0
#> [28,] 0 0 0 1 0
#> [29,] 1 5 1 0 0
#> [30,] 1 0 1 2 1