-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
148 lines (121 loc) · 11.4 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
options(width=110)
```
# inops
Package implementing additional infix operators for R.
Implemented operators work with 4 different value types: **sets**, **intervals**, **regular expressions**, and **counts**.\
And provide 3 distinct functionalities: **detection**, **subsetting**, and **replacement**.
For more examples please see the vignette.\
For a complete list of available operators consult the tables below.
## Syntax ##
All operators have the same form composed of two distinct parts: `%<operation><type>%`.
* `[operation]` specifies the performed functionality and can be one of `in`, `out`, `[in`, `[out`.
* `[type]` specifies the type of operation and can be one of `{}`, `[]`, `()`, `[)`, `(]`, `~`, `~p`, `~f`, `#`.
### Detection Operators ###
| Form | Description | Call |
|-------------|--------------------------------------------------------------------------|-------------------------------|
| `%in{}%` | which elements are inside a set | `x %in{}% set` |
| `%in[]%` | which elements are inside a closed interval | `x %in[]% interval` |
| `%in()%` | which elements are inside an open interval | `x %in()% interval` |
| `%in[)%` | which elements are inside an interval open on the right | `x %in[)% interval` |
| `%in(]%` | which elements are inside an interval open on the left | `x %in(]% interval` |
| `%in~%` | which elements match a regular expression | `x %in~% pattern` |
| `%in~p%` | which elements match a regular perl expression | `x %in~p% pattern` |
| `%in~f%` | which elements match a regular fixed expression | `x %in~f% pattern` |
| `%in#%` | which elements occur a specified number of times | `x %in#% count` |
| `%out%` | which elements are outside a set (same as ! x %in% y) | `x %out% set` |
| `%out{}%` | which elements are outside a set | `x %out{}% set` |
| `%out[]%` | which elements are outside a closed interval | `x %out[]% interval` |
| `%out()%` | which elements are outside an open interval | `x %out()% interval` |
| `%out[)%` | which elements are outside an interval open on the right | `x %out[)% interval` |
| `%out(]%` | which elements are outside an interval open on the left | `x %out(]% interval` |
| `%out~%` | which elements do not match a regular expression | `x %out~% pattern` |
| `%out~p%` | which elements do not match a regular perl expression | `x %out~p% pattern` |
| `%out~f%` | which elements do not match a regular fixed expression | `x %out~f% pattern` |
| `%out#%` | which elements occur other than a specified number of times | `x %out#% count` |
### Subsetting Operators ###
| Form | Description | Call |
|-------------|--------------------------------------------------------------------------|-------------------------------|
| `%[==%` | select elements equal to the provided value | `x %[==% element` |
| `%[!=%` | select elements not equal to the provided value | `x %[!=% element` |
| `%[>%` | select elements greater than the provided value | `x %[>% number` |
| `%[<%` | select elements lower than the provided value | `x %[<% number` |
| `%[>=%` | select elements greater or equal to the provided value | `x %[>=% number` |
| `%[<=%` | select elements lower or equal to the provided value | `x %[<=% number` |
| `%[in%` | select elements inside a set | `x %[in% set` |
| `%[in{}%` | select elements inside a set | `x %[in{}% set` |
| `%[in[]%` | select elements inside a closed interval | `x %[in[]% interval` |
| `%[in()%` | select elements inside an open interval | `x %[in()% interval` |
| `%[in[)%` | select elements inside an interval open on the right | `x %[in[)% interval` |
| `%[in(]%` | select elements inside an interval open on the left | `x %[in(]% interval` |
| `%[in~%` | select elements matching a regular expression | `x %[in~% pattern` |
| `%[in~p%` | select elements matching a regular perl expression | `x %[in~p% pattern` |
| `%[in~f%` | select elements matching a regular fixed expression | `x %[in~f% pattern` |
| `%[in#%` | select elements that occur a specified number of times | `x %[in#% count` |
| `%[out%` | select elements outside a set | `x %[out% set` |
| `%[out{}%` | select elements outside a set | `x %[out{}% set` |
| `%[out[]%` | select elements outside a closed interval | `x %[out[]% interval` |
| `%[out()%` | select elements outside an open interval | `x %[out()% interval` |
| `%[out[)%` | select elements outside an interval open on the right | `x %[out[)% interval` |
| `%[out(]%` | select elements outside an interval open on the left | `x %[out(]% interval` |
| `%[out~%` | select elements not matching a regular expression | `x %[out~% pattern` |
| `%[out~p%` | select elements not matching a regular perl expression | `x %[out~p% pattern` |
| `%[out~f%` | select elements not matching a regular fixed expression | `x %[out~f% pattern` |
| `%[out#%` | select elements that occur other than specified number of times | `x %[out% count` |
### Replacement Operators ###
| Form | Description | Call |
|-------------|--------------------------------------------------------------------------|-------------------------------|
| `==<-` | change elements equal to the provided value | `x == element <- value` |
| `!=<-` | change elements not equal to the provided value | `x != element <- value` |
| `><-` | change elements greater than the provided value | `x > number <- value` |
| `<<-` | change elements lower than the provided value | `x < number <- value` |
| `>=<-` | change elements greater or equal to the provided value | `x >= number <- value` |
| `<=<-` | change elements lower or equal to the provided value | `x <= number <- value` |
| `%in%<-` | change elements inside a set | `x %in% set <- value` |
| `%in{}%<-` | change elements inside a set | `x %in{}% set <- value` |
| `%in[]%<-` | change elements inside a closed interval | `x %in[]% interval <- value` |
| `%in()%<-` | change elements inside an open interval | `x %in()% interval <- value` |
| `%in[)%<-` | change elements inside an interval open on the right | `x %in[)% interval <- value` |
| `%in(]%<-` | change elements inside an interval open on the left | `x %in(]% interval <- value` |
| `%in~%<-` | change elements matching a regular expression | `x %in~% pattern <- value` |
| `%in~p%<-` | change elements matching a regular perl expression | `x %in~p% pattern <- value` |
| `%in~f%<-` | change elements matching a regular fixed expression | `x %in~f% pattern <- value` |
| `%in#%<-` | change elements that occur specified number of times | `x %in#% count <- value` |
| `%out%<-` | change elements outside a set | `x %out% set <- value` |
| `%out{}%<-` | change elements outside a set | `x %out{}% set <- value` |
| `%out[]%<-` | change elements outside a closed interval | `x %out[]% interval <- value` |
| `%out()%<-` | change elements outside an open interval | `x %out()% interval <- value` |
| `%out[)%<-` | change elements outside an interval open on the right | `x %out[)% interval <- value` |
| `%out(]%<-` | change elements outside an interval open on the left | `x %out(]% interval <- value` |
| `%out~%<-` | change elements not matching a regular expression | `x %out~% pattern <- value` |
| `%out~p%<-` | change elements not matching a regular perl expression | `x %out~p% pattern <- value` |
| `%out~f%<-` | change elements not matching a regular fixed expression | `x %out~f% pattern <- value` |
| `%out#%<-` | change elements that occur other than specified number of times | `x %out#% count <- value` |
## Notes ##
1. **Overloading**
To give an assignment counterpart to `<` we had to overload the `<<-` operator, which explains the message when attaching the package.
This doesn't affect the behavior of the `<<-` assignments.
2. **Behaviour**
Detection operators should be seen as an extension of the standard infix operators implemented in R (i.e. `==`, `>`, etc).
For this reason the implemented operators differ from standard `%in%` and behave more like `==` on `data.frames` and objects with `NA` values.
Subsetting and replacement operators are wrappers around detection operators.\
Subsetting: `x[ x %in{}% set]`.\
Replacement: `replace(x, x %in{}% set, value)`.
## See Also ##
Other similar packages you might be interested in.
1. [intrval](https://github.com/psolymos/intrval)
2. [operators](https://github.com/romainfrancois/operators)
3. [infix](https://github.com/ebeneditos/infix)
4. [invctr](https://github.com/FredHasselman/invctr)
5. [grapes](https://github.com/wlandau/grapes)