extract.simul_process: Extraction of simulated traits

View source: R/simulate.R

extract.simul_processR Documentation

Extraction of simulated traits

Description

extract.simul_process takes an object of class "simul_process", result of function simul_process, and extracts the traits values, expectations or optimal values at the tips or the internal nodes.

Usage

## S3 method for class 'simul_process'
extract(
  x,
  where = c("tips", "nodes"),
  what = c("states", "expectations", "optimal.values"),
  ...
)

Arguments

x

an object of class "simul_process", result of function simul_process.

where

one of "tips" (the default) or "nodes". Where to extract the results.

what

one of "states" (the default), "expectation", or "optimal.values".

...

unused

Details

##

Value

A matrix giving the selected quantities at the selected nodes or tips. If the tips or nods are labeled, then the colnames of the matrix are set accordingly.

See Also

simul_process


PhylogeneticEM documentation built on Aug. 31, 2022, 9:16 a.m.