sample_event_times: Sample event times.

View source: R/sample_event_times.R

sample_event_timesR Documentation

Sample event times.

Description

Sample event times.

Usage

sample_event_times(x = NULL, chronun_matrix, times, 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.

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 times, 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.