is.format: Determine whether an object is a user-defined format

In dbosak01/fmtr: Easily Apply Formats to Data

Determine whether an object is a user-defined format

Description

The is.format function can be used to determine if an object is a user-defined format of class "fmt".

Usage

is.format(x)

Arguments

x	A user-defined format of class "fmt".

Details

The is.format function returns TRUE if the object passed is a user-defined format. User-defined formats are defined using the value function. See the value function help for further details.

Value

A logical value or TRUE or FALSE.

See Also

value to define a format, condition to define the conditions for a format, and fapply to apply the format to a vector.

Other fmt: as.data.frame.fmt(), as.fmt(), as.fmt.data.frame(), condition(), labels.fmt(), print.fmt(), value()

Examples

# Define format
fmt1 <- value(condition(x == "A", "Label A"),
              condition(x == "B", "Label B"), 
              condition(TRUE, "Other"))
              
# Check for format
is.format(fmt1)
# [1] TRUE

is.format("A")
# [1] FALSE

dbosak01/fmtr documentation built on June 15, 2024, 4:26 a.m.