countSamples: Get Number of Included Samples in a Dataset

In microresearcher/MicroVis: Microbiome Analysis and Visualization

Get Number of Included Samples in a Dataset

Description

Get Number of Included Samples in a Dataset

Usage

countSamples(
  dataset = NULL,
  factors = NULL,
  stratifiers = NULL,
  getSizes = F,
  min_n = 3,
  verbose = T
)

Arguments

dataset	(Optional) MicroVis dataset (mvdata object). If not specified, defaults to active dataset.
factors	Factors along which samples will be split into groups. Default is the active factor of the dataset.
stratifiers	(Optional) Factors along which groups will be stratified. Default is none.
getSizes	Whether or not to return a nested list with the sizes of each groups. Default is FALSE.
min_n	Passed along to countSamples.base (non-exported function)
verbose	(Optional) If TRUE, will print out sizes of each group in each factor.

Value

If "getSizes" flag is TRUE, will report group sizes. If not, returns nothing.

microresearcher/MicroVis documentation built on Feb. 8, 2024, 10:59 a.m.