facet_frame: Retrieves grouping table for samples within a FacileDataSet.

View source: R/api.R

facet_frame.FacileDataSetR Documentation

Retrieves grouping table for samples within a FacileDataSet.

Description

It is natural to define subgroups of samples within larger datasets. This function returns grouping definitions (which we call "facets") for a FacileDataStore.

Usage

## S3 method for class 'FacileDataSet'
facet_frame(x, name = "default", ...)

facet_frame(x, name = "default", ...)

Arguments

x

An object of a class implementing the FacileInterface

name

The specific facet (grouping) definition to return. Note that this parameter isn't yet used. Only one facet table was originally defined for each FacileDataSet, but we want to enable different facet definitions to be used in the future.

Value

A tibble that defines the ⁠dataset,sample_id⁠ tuples that belong to each "facet" (group).

See Also

Other FacileInterface: fetch_assay_score(), fetch_sample_covariates(), fetch_sample_statistics(), samples()


facileverse/FacileData documentation built on Feb. 24, 2024, 7:59 a.m.