isAlignmentSignal: Rboretum Alignment Signal Checker

In BobLiterman/Rboretum: Compare Phylogenetic Trees and Alignment Support Values

Rboretum Alignment Signal Checker

Description

This function returns TRUE if the passed object is the output of getAlignmentSignal; otherwise, FALSE

Usage

isAlignmentSignal(test_object, species_info, return_taxa)

Arguments

test_object	R object to check
species_info	OPTIONAL: Check that passed signal contains information about a specific set of taxa. Set of 3+ species that can be passed as either: phylo object from which species will be extracted; or multiPhylo object from which common species will be extracted; or Character vector of desired taxa
return_taxa	OPTIONAL: If TRUE, if object appears to be signal, return signal taxa rather than TRUE or FALSE [Default: FALSE, return logical]

Value

TRUE if output of getAlignmentSignal(); otherwise, FALSE

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