Per-sample metrics joined to sample metadata — as.data.frame.gifter_dataset

Returns the per-sample metric table with the dataset's metadata columns beside it, ready to be handed to an external statistics package. gifter interprets none of those columns: a group, a timepoint or a treatment is the analyst's, and so is every test run on it.

Usage

# S3 method for class 'gifter_dataset_traits'
as.data.frame(x, row.names = NULL, optional = FALSE, ...)

Arguments

x: A `gifter_dataset_traits` from [dataset_traits()].
row.names, optional: Ignored; present for the generic.
...: Unused.

Value

A data frame of the per-sample metrics with the metadata columns appended.

Details

The join neither drops nor duplicates a sample, which [gifter_dataset()] makes provable rather than hoped for by requiring the metadata to cover exactly the samples the abundance names.

Sample-invariant rows — `gift_richness` and `repertoire_overlap` — are not included, because they belong to no sample. They are in `traits$catalogue_metrics`.