getState.Site: Get the current state of a Site object

Description Usage Arguments Value Author(s) See Also Examples

Description

Get the current state of a Site object.

Usage

1
2
## S3 method for class 'Site'
getState(this, ...)

Arguments

this

A Site object.

...

Not used.

Value

A character vector of length one contaning the state (a symbol belonging to the attached Alphabet object).

Author(s)

Botond Sipos, Gregory Jordan

See Also

For more information see Site.

Examples

1
2
3
4
5
6
7
8
	# create a Site object with an Alphabet object attached
	s<-Site(alphabet=Alphabet(symbols=c(0,1)), state=1);
	# get current state
	getState(s)
	# get state via virtual field
	s$state

 

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