null_dispersion_field_distribution: null_dispersion_field_distribution: Null distribution of the...

View source: R/null_dispersion_field_distribution.R

null_dispersion_field_distributionR Documentation

null_dispersion_field_distribution: Null distribution of the dispersion field

Description

null_dispersion_field_distribution estimates a random distribution of the dispersion field values.

Usage

null_dispersion_field_distribution(
  pam,
  n_iter = 10,
  parallel = TRUE,
  n_cores = 2
)

Arguments

pam

A Presence-Absence-Matrix of matrix class or sparse matrix.

n_iter

Number of iterations to obtain the distribution.

parallel

If TRUE the computations will be performed in parallel.

n_cores

Number of cores for the parallel computation.

Details

Estimates a random distribution of the dispersion field values. To obtein random values it uses the function codepermute_pam at each step of the iterations.

Value

A data matrix of size nrow(pam) X n_iter with dispersion field values.

References

\insertRef

Soberon2015bam

Examples

set.seed(111)
pam <- matrix(rbinom(100,1,0.3),nrow = 10,ncol = 10)
dfield_rand <- bam::null_dispersion_field_distribution(pam,n_iter=10,
                                                       parallel=FALSE,
                                                       n_cores = 2)

luismurao/bam documentation built on Nov. 28, 2022, 3:02 p.m.