phylosim (version 3.0.5)

getEventsAtSite.Process: Generate the list of active Event objects given a Site object

Description

Generate the list of active Event objects given a Site object. The Process object must be attached to the specified Site object.

This method is crucial for the simulations. For the Process class it returns an empty list. Descendant classes should implement meaningful getEventsAtSite methods.

Usage

# S3 method for Process
getEventsAtSite(this, site, position, ...)

Arguments

this

A Process object.

site

A valid Site object.

position

The position of the site in the enclosing Sequence object (if any).

...

Not used.

Value

An empty list.

See Also

For more information see Process.

Examples

# NOT RUN {
	# create objects
	a<-NucleotideAlphabet()
	p<-Process(alphabet=a)
	s<-Site(alphabet=a)
	# attach Process p to Site s
	s$processes<-list(p)
	# get active Event objects (empty list)
	getEventsAtSite(p,s)

 
# }