getOmegaScalingFactor.GY94: Get the omega scaling factor

Description Usage Arguments Value Author(s) See Also Examples

Description

Get the omega scaling factor.

The rate matrix of the GY94 model is scaled in a way that the expected number of potential substiutions per site is equal to one at equlibrium. The codeml program from the PAML package scales the rate matrix in order to have the expected number of accepted substiutions per site equal to one.

This method calculates the branch length multiplier needed for switching to PAML-style scaling given a fixed omega.

Usage

1
2
## S3 method for class 'GY94'
getOmegaScalingFactor(this, omega, ...)

Arguments

this

A GY94 object.

omega

The value of omega.

...

Not used.

Value

A numeric vector of length one.

Author(s)

Botond Sipos, Gregory Jordan

See Also

For more information see GY94.

Examples

1
2
3
4
5
	# construct a GY94 process object
	p<-GY94(kappa=4)
	# Calculate scaling factor for omega=2
	getOmegaScalingFactor(p,omega=2)
 

phylosim documentation built on Nov. 22, 2019, 1:07 a.m.