JitterModelParams: Add random white noise to the parameters of a model.

Description Usage Arguments Value

View source: R/JitterModelParams.R

Description

Add random white noise to the parameters of a model.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
JitterModelParams(
  model,
  argsPCMParamLowerLimit = NULL,
  argsPCMParamUpperLimit = NULL,
  numJitterRootRegimeFit = 1000,
  sdJitterRootRegimeFit = 0.5,
  numJitterAllRegimeFits = 1000,
  sdJitterAllRegimeFits = 0.5,
  returnWithinBoundsOnly = TRUE,
  verbose = FALSE
)

Arguments

model

a PCM object.

argsPCMParamLowerLimit, argsPCMParamUpperLimit

named lists with arguments passed to the functions PCMParamLowerLimit and PCMParamUpperLimit, respectively. Default: NULL.

numJitterRootRegimeFit, numJitterAllRegimeFits

integers specifying how many initial parameter vectors should be generated by 'jittering' the parameters of the root regime of a previously found fit (such as a clade-fit), and by jittering all regime parameters. Default: 100.

sdJitterRootRegimeFit, sdJitterAllRegimeFits

white noise standard deviation. Default: 0.5.

returnWithinBoundsOnly

logical indicating if only vectors within the boundaries specified by PCMParamLowerLimit(model) and PCMParamUpperLimit(model) should be returned.

verbose

logical indicating if debug messages should be printed to the console. Default: FALSE.

Value

a numerical matrix, each row corresponding to a jittered parameter vector.


venelin/PCMFit documentation built on June 7, 2021, 12:14 p.m.