numbers: Return some descriptive numbers

View source: R/getters.R

numbersR Documentation

Return some descriptive numbers

Description

get_numbers returns the number of samples, taxa and reads in a tidyamplicons object.

Usage

numbers(ta)

Arguments

ta

Tidyamplicons object.

Details

This function returns the number of samples, taxa and reads in a tidyamplicons object, stored in a named numeric vector. To print the numbers, use report_numbers instead.

Examples

# Initiate abundance matrix
x <- matrix(
 c(1500, 1300, 280, 356),
 ncol = 2
)
rownames(x) <- c("taxon1", "taxon2")
colnames(x) <- c("sample1", "sample2")

# Convert to tidyamplicons object
data <- create_tidyamplicons(x, taxa_are_columns = FALSE)

# Report numbers
numbers <- data %>% get_numbers()


SWittouck/tidyamplicons documentation built on Aug. 15, 2023, 3:14 a.m.