obitools/obitools4
2
0
Fork 0
mirror of https://github.com/metabarcoding/obitools4.git synced 2025-12-08 08:40:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

update api documentation

Browse Source
This commit is contained in:
Eric Coissac
2024-11-16 05:59:41 +01:00
parent 03f4e88a17
commit f5d79d0bc4
13 changed files with 372 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
pkg/obitax/issuubcladeof.go
View File

@@ -2,8 +2,16 @@ package obitax
import log "github.com/sirupsen/logrus"
// IsSubCladeOf checks if the current Taxon is a subclade of the specified parent Taxon.
// It returns true if the current Taxon is a descendant of the parent Taxon in the taxonomy hierarchy.
//
// Parameters:
// - parent: A pointer to the parent Taxon to check against.
//
// Returns:
// - A boolean indicating whether the current Taxon is a subclade of the parent Taxon.
// - Logs a fatal error if the two taxa do not belong to the same taxonomy.
func (taxon *Taxon) IsSubCladeOf(parent *Taxon) bool {
if taxon.Taxonomy != parent.Taxonomy {
log.Fatalf(
"Both taxa %s and %s must belong to the same taxonomy",
@@ -21,6 +29,15 @@ func (taxon *Taxon) IsSubCladeOf(parent *Taxon) bool {
return false
}
// IsBelongingSubclades checks if the current Taxon belongs to any of the specified subclades.
// It traverses up the taxonomy hierarchy to determine if the current Taxon or any of its ancestors
// belong to the provided TaxonSet.
//
// Parameters:
// - clades: A pointer to a TaxonSet containing the subclades to check against.
//
// Returns:
// - A boolean indicating whether the current Taxon or any of its ancestors belong to the specified subclades.
func (taxon *Taxon) IsBelongingSubclades(clades *TaxonSet) bool {
ok := clades.Contains(taxon.Node.id)