phylobase.options: Set or return options of phylobase

In phylobase: Base Package for Phylogenetic Structures and Comparative Data

Set or return options of phylobase

Description

Provides a mean to control the validity of phylobase objects such as singletons, reticulated trees, polytomies, etc.

Usage

phylobase.options(...)

Arguments

...	a list may be given as the only argument, or any number of arguments may be in the name=value form, or no argument at all may be given. See the Value and Details sections for explanation.

Details

The parameter values set via a call to this function will remain in effect for the rest of the session, affecting the subsequent behavior of phylobase.

Value

A list with the updated values of the parameters. If arguments are provided, the returned list is invisible.

Author(s)

Francois Michonneau (adapted from the package sm)

Examples

## Not run: 
phylobase.options(poly="fail")
# subsequent trees with polytomies will fail the validity check

## End(Not run)

phylobase documentation built on May 29, 2024, 11:24 a.m.