type.enum: Define a conformance rule to match a factor with specific...

In interfacer: Define and Enforce Contracts for Dataframes as Function Parameters

Define a conformance rule to match a factor with specific levels.

Description

Define a conformance rule to match a factor with specific levels.

Usage

type.enum(..., .drop = FALSE, .ordered = FALSE)

Arguments

...	the levels (no quotes, backticks if required)
.drop	should levels present in the data and not specified cause an error (FALSE the default) or be silently dropped to NA values (TRUE).
.ordered	must the factor be ordered

Value

a function that can check and convert input into the factor with specified levels. This will re-level factors with matching levels but in a different order.

Examples

f = type.enum(one,two,three)
f(c("three","two","one"))
f(factor(rep(1:3,5), labels = c("one","two","three")))

interfacer documentation built on April 4, 2025, 6:13 a.m.