countSamples.base: Core function for calculating sample sizes

View source: R/inspectDataset.R

countSamples.baseR Documentation

Core function for calculating sample sizes

Description

Core function for calculating sample sizes

Usage

countSamples.base(
  metadata,
  factors,
  stratifiers = NULL,
  min_n = 3,
  dataset = NULL,
  verbose = T
)

Arguments

metadata

Metadata of the dataset

factors

Factors along which samples will be counted in groups

stratifiers

Factors along which groups will be stratified

min_n

Threshold at which to warn user of a small sample size in a group or a stratified group.

dataset

(Optional) Dataset is passed to relay information about factors that is otherwise lost.

verbose

Whether or not to print out the size report for the groups/ stratified groups.

Value

Returns a nested list of the sample size for each group/stratified group


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