getEvents.Sequence: Get the list of active Event objects for a set of Site...

In phylosim: Flexible Simulations of Biological Sequence Evolution

Description

Get the list of active Event objects for a set of Site objects aggregated by a Sequence object.

Usage

## S3 method for class 'Sequence'
getEvents(this, index, ...)

Arguments

this	A Sequence object.
index	An integer vector specifying a set of positions. It is set to 1:seq$length if omitted.
...	Not used.

Value

A list of Event objects.

Author(s)

Botond Sipos, Gregory Jordan

See Also

For more information see Sequence.

Examples

	# create a sequence with a process attached
	s<-Sequence(
               string="ATGC",
               alphabets=list(NucleotideAlphabet()),
               processes=list(list(JC69()))
               )
	# get the active events from range 1:3
	getEvents(s,1:3)
	# get all active events via virtual field
	s$events
 

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