pf.BINprojection: Projects phylofactored data onto bins defined by the factors...

View source: R/pf.BINprojection.R

pf.BINprojectionR Documentation

Projects phylofactored data onto bins defined by the factors 1:factor

Description

Projects phylofactored data onto bins defined by the factors 1:factor

Usage

pf.BINprojection(PF, factor = PF$nfactors, taxonomy = NULL,
  common.name = F, uniques = T, prediction = F, rel.abund = F,
  minimum.tax = "p")

Arguments

PF

phylofactor object. See PhyloFactor

factor

integer between 0 and PF$nfactors

taxonomy

Optional taxonomy. If input, the list of OTUs in each bin will be the taxonomic names, not the OTU IDs.

common.name

Logical. If input taxonomy, will indicate whether to trim taxonomic list to the longest common prefix of each bin.

uniques

Logical. If input taxonomy, will indicate whether to trim the taxonomic list to the unique names.

prediction

Logical. If true, will output the predictions for each bin instead of the observations.

rel.abund

Logical. If true, will return the total relative abundances in the bin. Default, F, returns the geometric mean of the relative abundances of each bin

minimum.tax

minimum taxonomic description - see OTUtoTaxa

Value

Returns list containing the compositional dataset formed by the bins and the list of OTUs in each bin.


reptalex/phylofactor documentation built on Feb. 28, 2024, 3:19 p.m.