transMatMakerMuHiSSE: Transition Rate matrix generator for the MuHiSSE model

Description Usage Arguments Details Value

Description

Generates and manipulates the index of the transition rate parameters to be optimized.

Usage

1
2
TransMatMakerMuHiSSE(hidden.traits=0, make.null=FALSE, include.diagonals=FALSE, 
cat.trans.vary=FALSE)

Arguments

hidden.traits

a numeric value with the number of hidden states in the model. The canonical MuSSE model has no hidden states, so 'hidden.traits=0'. The default value is 0.

make.null

Sets the transition matrix to the null model such that (1) transition rates are the same across all hidden states and (2) the transition rates between hidden states (such as 00A <-> 01A) are the same.

include.diagonals

allows for dual transitions, e.g., 00->11 and 11->00 transitions.

cat.trans.vary

sets transitions among hidden categories to vary.

Details

Outputs the full index of the rate parameters that are to be optimized.

The intention is that a user might want to see how the matrix is designed prior to an analysis and perhaps drop a few parameters beforehand due to some hypothesis that she might have. The resulting matrix is to be plugged directly into MuHiSSE.

Value

Returns a rate matrix index.


hisse documentation built on Nov. 16, 2021, 9:09 a.m.