enum: Create enum S3 class given a vector of strings and an enum...

Description Usage Arguments Examples

View source: R/enum.R

Description

Factory function enum that takes a vector of strings and a name and returns an enum object. Dispatches on case-insensitive indexing argument list

Usage

1
enum(enums, name = NULL)

Arguments

enums

list of (symbol, value) mappings for enumerable class

name

(optional) name of enumerable class

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
col <- enum(c("BLUE", "red", "Black"), name = "TheColors")
col$R
#> [1] "RED"
class(col)
#> [1] "TheColors" "enum"      "list"

side <- enum(c("left", "right"))
side$L
#> [1] "LEFT"
class(side)
#> [1] "enum" "list"

ifrit98/museR documentation built on May 25, 2020, 6:12 a.m.