refCat: summaryFunction that finds reference level for factor...

In dataMaid: A Suite of Checks for Identification of Potential Errors in a Data Frame as Part of the Data Screening Process

Description

A summaryFunction, intended to be called from summarize, which returns the reference level of a factor variable, i.e. the first category as returned by levels(v). This level will serve as the reference category and get absorbed into the intercept for most standard model fitting procedures and therefore, it may be convenient to know.

Usage

refCat(v, ...)

Arguments

v	A variable (vector) of type factor.
...	Not in use.

Value

An object of class summaryResult with the following entries: $feature ("Reference level"), $result (the reference level of v), and $value (identical to result).

See Also

summaryFunction, summarize, summaryResult, allSummaryFunctions

Examples

refCat(factor(letters))

dataMaid documentation built on Oct. 8, 2021, 9:08 a.m.