clean: Delete orphaned records

cleanR Documentation

Delete orphaned records

Description

Manipulation of slots may generate orphaned entries in taxlist objects. The function clean deletes such entries and restores the consistency of the objects.

Usage

clean(object, ...)

## S4 method for signature 'taxlist'
clean(object, times = 2, ...)

Arguments

object

A taxlist object.

...

Further arguments passed from or to other methods.

times

An integer indicating how many times the cleaning should be repeated.

Details

Cleaning of objects will follow the deletion of orphaned names, orphaned taxon trait entries, and orphaned parent entries.

Value

A clean taxlist object.

Author(s)

Miguel Alvarez.

Examples

## Direct manipulation of slot taxonRelations generates an invalid object
Easplist@taxonRelations <- Easplist@taxonRelations[1:5, ]

## Now apply cleaning
Easplist <- clean(Easplist)
summary(Easplist)

ropensci/taxlist documentation built on Sept. 17, 2024, 3:39 p.m.