is.enum_value.RdTEMPORARY DOCUMENTATION
117 | 118 |is.enum_value(object)121 | 122 | 123 |
get_enum_values.RdTEMPORARY DOCUMENTATION
117 | 118 |get_enum_values(enum_type)121 | 122 | 123 |
add_enum_methods.RdTEMPORARY DOCUMENTATION
117 | 118 |add_enum_methods(enum_type, ...)121 | 122 | 123 |
get_enum_method.RdTEMPORARY DOCUMENTATION
117 | 118 |get_enum_method(enum_value, method)121 | 122 | 123 |
methodize.Rd@description TEMPORARY DOCUMENTATION
117 | 118 |methodize(enum_type, method)121 | 122 | 123 |
apply_enum_method.RdTEMPORARY DOCUMENTATION
117 | 118 |apply_enum_method(enum_value, method, ...)121 | 122 | 123 |
print.enum_value.RdTEMPORARY DOCUMENTATION
117 | 118 |# S3 method for enum_value 121 | print(enum_value)122 | 123 | 124 |
cash-.enum_type.Rdplaceholder
117 | 118 |# S3 method for enum_type 121 | $(enum_type, value)122 | 123 |
| enum_type | 128 |enum_type |
129 |
|---|---|
| index | 132 |index |
133 |
sub-.enum_type.Rdplaceholder
117 | 118 |# S3 method for enum_type 121 | [(enum_type, index)122 | 123 |
| enum_type | 128 |enum_type |
129 |
|---|---|
| index | 132 |index |
133 |
subset-.enum_type.Rdplaceholder
117 | 118 |# S3 method for enum_type 121 | [(enum_type, index) <- value122 | 123 |
| enum_type | 128 |enum_type |
129 |
|---|---|
| index | 132 |index |
133 |
cash-set-.enum_type.Rdplaceholder
117 | 118 |# S3 method for enum_type 121 | $(enum_type, index) <- value122 | 123 |
| enum_type | 128 |enum_type |
129 |
|---|---|
| index | 132 |index |
133 |
print.enum_type.RdPretty prints enum_type object. Overloads default print.
117 | 118 |# S3 method for enum_type 121 | print(enum_type)122 | 123 |
| enum_type | 128 |Object of class enum_type |
129 |
|---|
as.enum_type.RdFunctions to check if an object is an enum type, or coerce it if possible.
117 | 118 |as.enum_type(x)121 | 122 |
| x | 127 |any R object |
128 |
|---|
Object of class enum_type
This package provides enum_type and enum classes, which allows to create and instantinize enumerable types in R
77 |It is in it’s early development and authors don’t grat any assurance that function names, parameters or functionalities won’t change in future.
78 |To install this package you need to use devtools library, which can be installed with:
install.packages("devtools")If you have already installed devtools, you need to run following code to install this package:
devtools::install_github("DominikRafacz/enumeR")get_enum_index.RdExtracts `index` attribute value of passed `enum_value`.
117 | 118 |get_enum_index(enum_value)121 | 122 |
| enum_value | 127 |object of class `enum_value` or list of such objects with the same `enum_type` |
128 |
|---|
integer index of `enum_value` or named vector of integers coresponding to values in list
134 | 135 | 136 |enum_type.RdCreates new enum type.
117 | 118 |enum_type(type_name, values_names, ...)121 | 122 |
| type_name | 127 |Character vector of length 1. Name of the type. Type name will be referenced by this value |
128 |
|---|---|
| ... | 131 |Optional other fields that are used during constructing enum_values |
132 |
| value_names | 135 |Character vector of positive length. Possible names of enum_values (instances) |
136 |
is.enum_type.RdThis function checks class of passed object. If vector of classes contains
121 | "enum_type", then checks if all necessary fields are not null, namely
122 | type_name and values, and whether type_name is a singular
123 | character vector. Next, checks if fields_names is a character vector or null.
124 | Lastly, all values need to be unique and proper enum_value objects.
is.enum_type(object)129 | 130 |
TRUE if the object passed all tests described above, FALSE otherwise.
sample_enum.RdThis is a wrapper around [sample()] to make selecting random enum values easier.
117 | 118 |sample_enum(enum_type, size, replace = FALSE, weight = NULL)121 | 122 |
| enum_type | 127 |Object that passes [is.enum_type()] check. |
128 |
|---|---|
| size | 131 |A non-negative integer giving number of items to choose. |
132 |
| replace | 135 |Should sampling be with replacement? |
136 |
| weight | 139 |Sampling weights. This must evaluate to a vector of non-negative numbers the same 140 | length as the input. Weights are automatically standardised to sum to 1. |
141 |
A list of enum values of length size drawn from enum_type's values.
Introduction.RmdThis vignette will introduce you to basic functionalities of enumeR package.
First we create some enum_type object. It represents a class with finite number of possible values - similliar to enums from other languages like C++ or Java. During construction of an object besides names of values you can specify values of own fields that will be kept inside values. For example:
season_of_year <- enum_type("season_of_year",
87 | c("SPRING", "SUMMER", "AUTUMN", "WINTER"),
88 | min_temperature = c(-13, 7, -6, -20),
89 | max_temperature = c(20, 32, 18, 12))
90 |
91 | print(season_of_year)
92 | #> Enum type: season_of_year
93 | #>
94 | #> Values:
95 | #> 1 : SPRING
96 | #> 2 : SUMMER
97 | #> 3 : AUTUMN
98 | #> 4 : WINTER
99 | #> $SPRING
100 | #> NULL
101 | #>
102 | #> $SUMMER
103 | #> NULL
104 | #>
105 | #> $AUTUMN
106 | #> NULL
107 | #>
108 | #> $WINTER
109 | #> NULLNow you can access values of this type:
111 |my_favourite_seasons <- season_of_year[c(1,4)]
112 | my_hated_seasons <- season_of_year[c("SUMMER","AUTUMN")]
113 | holiday_season <- season_of_year$SUMMER… but cannot modify it:
115 |season_of_year$SUMMER <- "something"
116 | #> Error in `$<-.enum_type`(`*tmp*`, SUMMER, value = "something"): You cannot modify enum_type values!You can also choose a random subset:
118 | 119 |Objects have thier own classes, which can be checked:
120 |class(season_of_year)
121 | #> [1] "enum_type"
122 | class(holiday_season)
123 | #> [1] "enum_value"
124 | is.enum_type(season_of_year)
125 | #> [1] TRUE
126 | is.enum_value(holiday_season)
127 | #> [1] TRUEYou can add methods to enum_type which will be accessing its fields. You can access these fields using their names with dot before it. Thus it’s not recommended to add fields which names begin with dot.