cleanup_mcols: Remove valueless mcols from an object

In DarwinAwardWinner/rctutils: Utility functions by Ryan C. Thompson

Remove valueless mcols from an object

Description

Any mcols for which is_valueless() returns TRUE will be removed.

Usage

cleanup_mcols(object, mcols_df = S4Vectors::mcols(object))

Arguments

object	The object whose mcols should be cleaned.
mcols_df	Instead of passing object, you can pass a data frame (or S4Vectors::DataFrame) using this named argument.

Value

If object was passed, it is returned with any valueless mcols removed. If mcols_df was passed and object was not, the data frame is returned directly.

Note that mcols_df can only be passed by name. An unnamed argument is always interpreted as object.

See Also

S4Vectors::mcols(), is_valueless()

Examples

#TODO

DarwinAwardWinner/rctutils documentation built on July 22, 2022, 5:19 a.m.