summarise_physeq: Summarize a phyloseq object

Description Usage Arguments Value Author(s) Examples

View source: R/summarise_physeq.R

Description

Summarize the total number of ASVs, number of ASVs in a subset and percentage of reads this ASV subset contains (of total) of a given phyloseq object.

Usage

1
2
3
4
5
6
summarise_physeq(
  physeq = ps,
  ASV_sublist = c(),
  sublist_id = "sublist_id_not_defined",
  samp_names = TRUE
)

Arguments

physeq

a phyloseq object to be summarized

ASV_sublist

a character vector of ASVs/OTUs (phyloseq taxa). Empty by default. If provided the summary will contain the percentage of abundance the sublist comprises. Compatible with cuphyr::list_subset_ASVs().

sublist_id

a character string describing the subset of taxa provided in ASV_sublist

samp_names

TRUE/FALSE. If TRUE (default), sample names in the subset are included in the summary.

Value

a character string summarising the provided phyloseq object

Author(s)

Simeon Rossmann

Examples

1
2
3
4
5
summarise_physeq(ps)
summarise_physeq(ps, ASV_sublist= c("ASV1"), sublist_id ="ASV1", samp_names=FALSE)

phyt_ASVs <- cuphyr::list_subset_ASVs(physeq = ps, subv = c("Phytophthora","Phytopythium"), taxlvlsub="Genus")
summarise_physeq(ps, ASV_sublist= phyt_ASVs, sublist_id ="Phytophthora and Phytopythium", samp_names=FALSE)

simeross/CuPhyR documentation built on April 1, 2020, 10:28 a.m.