getEvents.Site: Get the list of active event objects given the current state...

Description Usage Arguments Value Author(s) See Also Examples

Description

Get the list of active event objects given the current state of the Site object. The list of active event object might change according to the state of the Site object.

Usage

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

Arguments

this

A Site object.

...

Not used.

Value

A list of event objects.

Author(s)

Botond Sipos, Gregory Jordan

See Also

For more information see Site.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
	# create a site object with a JC69 substitution process attached
	s<-Site(alphabet=NucleotideAlphabet(), state="A",processes=list(JC69()))
	# get the list of active event objects
	getEvents(s)
	# modify site state
	s$state<-"T"
	# get the list of active event objects via virtual field
	s$events

 

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