sample_event_counts: Sample event counts.

In wccarleton/chronup: Chronological Uncertainty Propagation Toolkit

Sample event counts.

Description

Sample event counts.

Usage

sample_event_counts(
  x = NULL,
  chronun_matrix,
  times,
  breaks = NULL,
  BP = T,
  bigmatrix = NULL
)

Arguments

x	An integer specifying the index of a vector to enable easy vectorization and/or parallelization, or NULL (default) if not using a vectorized or parallel function call (e.g., apply() or parApply()). If you're not using a parallel apply function (e.g., parApply), ignore this parameter.
chronun_matrix	A matrix containing discrete estimates describing chronological uncertainty. Each column should contain density estimates for a single event and the rows should each refer to discrete times.
times	A vector of possible event times.
breaks	A vector containing (time) bin edges used for counting events. These edges need not define intervals at the same resolution as the times argument (e.g., times can refer to years while the bins can refer to decades). But, keep in mind that the bins should include all of the possible intervals into which events can fall. Also, the bin edges defined by this argument will serve as the right-most boundary condition which will be closed, i.e., the interval will be left-open and right-closed: ( ].
BP	Logical (default T). Assume a Before Present timescale?
bigmatrix	A character vector containing a path pointing to a 'bigmemory' matrix descriptor file, or NULL (default).

Value

A vector containing a sample of probable event counts, if not calling this function with a parallel function (e.g., parApply). If using something like apply() or 'parApply()', this function will return a matrix. If the bigmemory argument is not NULL, this function will return nothing and instead write the output to the relevant big matrix file.

wccarleton/chronup documentation built on March 29, 2023, 1:24 a.m.