summary: Object Summaries

Description Usage Arguments Value Author(s) See Also Examples

Description

Produces result summaries.

Usage

1
2
## S4 method for signature 'AbundanceMatrix'
summary(object, ...)

Arguments

object

An AbundanceMatrix object.

...

Currently not used.

Value

An AbundanceSummary object.

Author(s)

N. Frerebeau

See Also

Other mutators: mutators, subset()

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
## Create a data.frame
X <- matrix(data = sample(0:10, 50, TRUE), nrow = 10, ncol = 5)
Y <- as.data.frame(X)

## Coerce to a count matrix
Z <- as_count(Y)

## Set/get groups
set_samples(Z) <- rep(c("a", "b", "c", "d", "e"), each = 2)
get_samples(Z)

## Set/get groups
set_groups(Z) <- rep(c("A", "B"), each = 5)
get_groups(Z)

## Get/get TPQ/TAQ
chrono <- list(
  tpq = sample(1301:1400, 10, replace = TRUE),
  taq = sample(1451:1500, 10, replace = TRUE)
)
set_terminus(Z) <- chrono
get_terminus(Z)

## Collection of features
as_features(Z)

## Summarize data
summary(Z)

arkhe documentation built on Sept. 18, 2021, 5:07 p.m.