Learn R Programming

phylobase (version 0.6.8)

phylobase.options: 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.
singleton
warn, fail or OK. Are singleton nodes allowed? warn returns a warning (default) and fail returns an error message
multiroot
warn, fail or OK. Are multiple roots allowed? warn returns a warning (default) and fail returns an error message
poly
warn, fail or OK. Are polytomies allowed? warn returns a warning (default) and fail returns an error message
allow.duplicated.labels
warn, fail or OK. Are duplicated labels allowed? warn returns a warning and fail (default) returns an error message

Value

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

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.

Examples

Run this code
phylobase.options(poly="fail")
# subsequent trees with polytomies will fail the validity check

Run the code above in your browser using DataLab