Summary: Provides high level summary of model results.

View source: R/Summary.R

SummaryR Documentation

Provides high level summary of model results.

Description

This function takes the output of an LTNLDA function as an input, and finds the average subcommunity abundance in decreasing order, as well as the top n ASVs characterizing each subcommunity. More detailed information in "LTN-LDA" vignette.

Usage

Summary(model, n = 5)

Arguments

model

The output of an LTNLDA model trained on a training set.

n

We find the n most prevalent ASVs in each subcommunity, with proportions.

Value

A list with two entries. Abundance is a vector of the average subcommunity prevalence in all samples in decreasing order. Top_ASVs is a list such tha the kth entry is the the top n ASVs characterizing the kth subcommunity (in decreasing order of average subcommunity prevalence) as well the corresponding ASV prevalencies.

References

ADD PAPER INFORMATION ONCE WE KNOW IT

Examples

data("ps",package = "LTNLDA")
K = 2
model = LTNLDA(ps,K)
sum = Summary(model)

PatrickLeBlanc/LTNLDA documentation built on May 22, 2022, 12:49 p.m.