Scale.QMatrix: Scale the scaled rate matrix stored in a QMatrix object by...

In phylosim: Flexible Simulations of Biological Sequence Evolution

Description

Scale the scaled rate matrix stored in a QMatrix object by the provided factor.

This methods sets the scaled rate matrix to unscaled_matrix * constant.

Usage

## S3 method for class 'QMatrix'
Scale(this, constant=NA, ...)

Arguments

this	A QMatrix object.
constant	The scaling factor (a numeric vector of length one).
...	Not used.

Value

The QMatrix object (invisible).

Author(s)

Botond Sipos, Gregory Jordan

See Also

For more information see QMatrix.

Examples

	# create a QMatrix object
	# , provide Alphabet object and rates
	m<-QMatrix(name="Susie Q", alphabet=BinaryAlphabet(), rate.list=list("1->0"=2,"0->1"=3))
	# get object summary
	summary(m)
	# perform scaling
	Scale(m, 1/0.666)
	# get object summary
	summary(m)
 

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