PCMCond: Conditional distribution of a daughter node given its parent...

View source: R/PCM.R

PCMCondR Documentation

Conditional distribution of a daughter node given its parent node

Description

An S3 generic function that has to be implemented for every model class.

Usage

PCMCond(
  tree,
  model,
  r = 1,
  metaI = PCMInfo(NULL, tree, model, verbose = verbose),
  verbose = FALSE
)

Arguments

tree

a phylo object with N tips.

model

an S3 object specifying both, the model type (class, e.g. "OU") as well as the concrete model parameter values at which the likelihood is to be calculated (see also Details).

r

an integer specifying a model regime

metaI

a list returned from a call to PCMInfo(X, tree, model, SE), containing meta-data such as N, M and k. Alternatively, this can be a character string naming a function or a function object that returns such a list, e.g. the functionPCMInfo or the function PCMInfoCpp from the PCMBaseCpp package.

verbose

logical indicating if some debug-messages should printed.

Value

an object of type specific to the type of model


PCMBase documentation built on Nov. 18, 2022, 9:06 a.m.