PCMParamLoadOrStore: Load (or store) a PCM parameter from (or to) a vector of the...

In venelin/PCMBase: Simulation and Likelihood Calculation of Phylogenetic Comparative Models

Load (or store) a PCM parameter from (or to) a vector of the variable parameters in a model.

Description

Load (or store) a PCM parameter from (or to) a vector of the variable parameters in a model.

Usage

PCMParamLoadOrStore(o, vecParams, offset, k, R, load, parentModel = NULL)

Arguments

o	a PCM model object or a parameter of a PCM object
vecParams	a numeric vector.
offset	an integer denoting an offset count from which to start counting (internally used). Default: 0.
k	an integer denoting the number of modeled traits. Default: 1.
R	an integer denoting the number of regimes in the model. Default: 1.
load	logical indicating if parameters should be loaded from vecParams into o (TRUE) or stored to vecParams from o (FALSE).
parentModel	NULL or a PCM object. Default: NULL.

Details

This S3 generic function has both, a returned value and side effects.

Value

an integer equaling the number of elements read from vecParams. In the case of type=="custom", the number of indices bigger than offset returned by the function indices(offset, k).

venelin/PCMBase documentation built on March 14, 2024, 8:24 p.m.