isAlignmentSupport: Rboretum Alignment Support Checker

View source: R/isAlignmentSupport.R

isAlignmentSupportR Documentation

Rboretum Alignment Support Checker

Description

This function returns TRUE if the passed object is the output of getAlignmentSupport() and contains information about clades in 'test_clade'; otherwise, FALSE

Usage

isAlignmentSupport(test_object, test_clade, partial)

Arguments

test_object

R object to check

test_clade

Source for clades to check. Function checks that passed support object contains information about these clades. Options include:

  • Rooted phylo or multiPhylo object

  • vector of semicolon-separated clades.

partial

OPTIONAL: If TRUE, as long as all clades from 'test_clade' are present, return TRUE [Default: FALSE, require that test_clades also includes all clades in support object]

Value

TRUE if output of getAlignmentSupport() with information on 'test_clade'; otherwise, FALSE


BobLiterman/Rboretum documentation built on July 6, 2023, 7:46 p.m.