subsetting: Subsetting enums

In ElianHugh/enumr: Static Enumerations

Description

Access enum members through subsetting with numeric or character indices.

• Enums are converted to a list type through the as.list method, before being subset by an index.

• Partial matching via [, [[, or $ is not supported, and will return NULL. This is intended to incentivise literate programming, as partial matching can lead to errors.

• Enums are not intended to be used as interactive data structures. Assigning to enum members is not supported, and will throw an error if attempted. If you require an enum to be modifiable, consider using a list instead.

Usage

## S3 method for class 'enum'
x[arg]

## S3 method for class 'enum'
x[[arg]]

## S3 method for class 'enum'
x$arg

## S3 replacement method for class 'enum'
x$arg <- value

## S3 replacement method for class 'enum'
x[arg] <- value

## S3 replacement method for class 'enum'
x[[arg]] <- value

Arguments

x	enum to subset
arg	value to subset enum with, generally the indices of the enum
value	assigning values to enums is not allowed

Examples

a <- enum(a,b,c)

a[1]

a[[1]]

a$a

ElianHugh/enumr documentation built on Dec. 17, 2021, 6:25 p.m.