tbl_utilities: Helper functions for simplifying colData

In mtmorgan/HCAmtxzip: Represent Human Cell Atlas 'MTX' bundles as SingleCellExperiment

Description

'colTibble()' creates a tibble from 'colData()'

'constant()' scans 'colData()' columns to identify those with a single distinct value.

'brief()' produces a subset of 'colData()' columns which contain more than one distinct value.

Usage

colTibble(sce, ...)

rowTibble(sce, ...)

constant(.data)

brief(.data, abbreviate_names = TRUE)

Arguments

sce	a 'SummarizedExperiment' or derived object, e.g., a 'SingleCellExperiment'.
...	additional arguments passed to 'as_tibble()', e.g., to map rownames to a column.
.data	A 'data.frame()' or 'tibble()'.
abbreviate_names	logical(1) when 'TRUE', abbreviate column names to the shortests common 'word' (using '[[:punct:]]+' as separators) suffixes. E.g., column names '"a.b.c"' and 'd.e.c' would abbreviate to 'b.c' and 'e.c'.

Value

'colTibble()' returns a tibble representation of 'colData()'.

'rowTibble() returns a tibble representation of 'rowData()'.

'constant()' returns a two-column tibble. The first column, 'key' corresponds to 'colData()' column names for which only a single distinct value is present. The second column 'value' is the unique value.

'brief()' returns a tibble containing only those 'colData()' columns with more than one value, and with (by default) column names abbreviated to the shortests common 'word' (using '[[:punct:]]+' as separators) suffixes.

mtmorgan/HCAmtxzip documentation built on Nov. 24, 2019, 12:26 p.m.