metacoder (version 0.1.3)

obs: Get observations associated with taxa

Description

Given one or more taxa IDs and a taxmap object, return the observation indexes (e.g. sequence information) associated with each taxon.

Usage

obs(obj, subset = NULL, recursive = TRUE, simplify = FALSE)

Arguments

obj

(taxmap) The taxmap object containing taxon information to be queried.

subset

(character) taxon_ids or indexes of taxon_data for which supertaxa will be returned. Default: All taxa in obj will be used.

recursive

(logical) If FALSE, only return the observation assigned to the specified input taxa, not subtaxa. If TRUE, return all the observations of every subtaxa, etc.

simplify

(logical) If TRUE, then combine all the results into a single vector of unique observation indexes.

Value

If simplify = FALSE, then a list of vectors of observation indexes are returned corresponding to the target argument. If simplify = TRUE, then the observation indexes for all target taxa are returned in a single vector.

See Also

Other taxmap taxonomy functions: roots, subtaxa, supertaxa