as.data.frame.enumeration: Creates a data.frame with all elements of an enum

In aryoda/R_enumerations: Adds an enumeration data type for R to support list of allowed value/label pairs

Description

The data.frame is useful for debugging purposes, filling list and combo boxes in user interfaces to select one value etc.

Usage

## S3 method for class 'enumeration'
as.data.frame(x, row.names = NULL,
  optional = FALSE, ...)

Arguments

x	An object of class "enumeration" (created with create.enum)
row.names	NULL or a character vector giving the row names for the data frame. Missing values are not allowed.
optional	Currently not used (but required for a compatible S3 interface)
...	Currently not used (but required for a compatible S3 interface)

Value

A data.frame with three columns: allowed.values, value.names and descriptions. The 'descriptions' column is set to the names attribute of the enum if no 'descriptions' attribute exists. Character strings are never converted to factors (stringsAsFactors = FALSE).

Examples

DRINKS <- create.enum(c(COFFEE = 1, TEA = 2, SOFT_DRINK = 3),
                      descriptions = c("hot", "hotter", "cold"))
as.data.frame(DRINKS)

aryoda/R_enumerations documentation built on Dec. 9, 2019, 8:51 a.m.