-
Notifications
You must be signed in to change notification settings - Fork 5
/
translate.R
303 lines (260 loc) · 6.86 KB
/
translate.R
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
#' @rdname translate
#' @export
translate_string <- function(
expression,
speak = TRUE,
function_call_end = "of "
) {
if (!is.character(expression) & length(expression != 1)) {
stop("The 'expression' argument must be a character string.\n")
}
if (!is.logical(speak)) {
stop("The 'speak' argument must be TRUE or FALSE.\n")
}
if (!is.character(function_call_end) & length(function_call_end != 1)) {
stop("The 'function_call_end' argument must be a character string.\n")
}
.convert_quoted_expression(
rlang::parse_expr(expression),
speak = speak, function_call_end = function_call_end
)
}
#' Translate R Code To Spoken English
#'
#' Takes an R expression and converts it to English by matching recognised
#' symbols with an opinionated list of English 'translations'.
#'
#' @param expression An R expression (bare if \code{translate()}, quoted if
#' \code{translate_string()}).
#' @param speak Logical. Do you want your system to try and say the English
#' expression? macOS only. Requires speakers on your machine.
#' @param function_call_end Character, what should be added after a function
#' call, e.g. setting this parameter to "of", this function translates
#' \code{summary(x)} to "summary of x open paren x close paren".
#' @return An r2eng object, which is a list with three elements: the input
#' R expression, the 'translated' English expression and a data frame
#' showing the translation of each R element.
#' @export
#' @examples
#' \dontrun{
#' translate(variable <- 1)
#' }
translate <- function(expression, speak = TRUE, function_call_end = "of ") {
quoted_expression <- substitute(expression)
if (!is.logical(speak)) {
stop("The 'speak' argument must be TRUE or FALSE.\n")
}
if (!is.character(function_call_end) & length(function_call_end != 1)) {
stop("The 'function_call_end' argument must be a character string.\n")
}
.convert_quoted_expression(
quoted_expression,
speak = speak,
function_call_end = function_call_end
)
}
.convert_quoted_expression <- function(
quoted_expression,
speak = TRUE,
function_call_end = "of "
) {
trees <- .convert_expr_tree(deparse(quoted_expression))
trees_nrow <- nrow(trees)
eng_vec <- vector("character", length = trees_nrow)
for (i in seq_len(trees_nrow)) {
eng_vec[[i]] <- .translate(
token = trees[i, "token"],
text = trees[i, "text"],
function_call_end = function_call_end
)
}
eng_expression <- gsub(" +", " ", paste0(eng_vec, collapse = " "))
trees$eng <- eng_vec
# Output a list of results
results <- list(
r_expression = deparse(quoted_expression), # R expression as string
eng_expression = eng_expression, # translated English expression
translation_map = trees, # table mapping R to English
quoted_expression = quoted_expression
)
class(results) <- append(class(results), "r2eng")
if (speak) {
speak(results)
}
return(results)
}
#' Speak out the English expression of r2eng object
#'
#' This function speaks the English expression of the r2eng object. Currently,
#' only macOS is supported.
#' @param r2eng An r2eng object to speak.
#' @param ... Other arguments to pass.
#' @return Nothing.
#' @export
speak <- function(r2eng, ...) {
UseMethod("speak", r2eng)
}
#' Evaluate expression in r2eng object
#'
#' This function evaluates the expression of the r2eng object.
#' @param r2eng An r2eng object to evaluate.
#' @param envir Environment to evaluate the expression. Defaults to current
#' environment.
#' @param ... Other arguments to pass.
#' @return Nothing.
#' @export
evaluate <- function(r2eng, ...) {
UseMethod("evaluate", r2eng)
}
#' @rdname evaluate
#' @export
evaluate.r2eng <- function(r2eng, envir = parent.frame(), ...) {
eval(r2eng$quoted_expression, envir = envir)
}
#' @rdname speak
#' @export
speak.r2eng <- function(r2eng, ...) {
system(
paste0(
"say '",
paste0(utils::tail(r2eng$translation_map$eng, -1), collapse = ","),
"'"
)
)
}
#' Print r2eng Object For Reading
#'
#' Print the r2eng object to see the original and translated expressions.
#' @param x An r2eng object to print.
#' @param ... Other arguments to pass.
#' @return Nothing.
#' @export
print.r2eng <- function(x, ...) {
cat(paste0("Original expression: ", x$r_expression, "\n"))
cat(paste0("English expression:", x$eng_expression, "\n"))
}
.convert_expr_tree <- function(expression) {
parsed <- parse(text = expression, keep.source = TRUE)
parse_data <- utils::getParseData(parsed)
parse_data[, c("token", "text")]
}
.translate <- function(token, text, function_call = "", function_call_end = "") {
# Arithmetic/conditions
if (token == "'+'") {
return("plus")
}
if (token == "'-'") {
return("minus")
}
if (token == "'*'") {
return("times")
}
if (token == "'/'") {
return("over")
}
if (token %in% c("'^'", "'**'")) {
return("raised to the power of")
}
if (token == "GT") {
return("is greater than")
}
if (token == "GE") {
return("is greater than or equal to")
}
if (token == "LT") {
return("is less than")
}
if (token == "LE") {
return("is less than or equal to")
}
if (token == "EQ") {
return("double equals")
}
if (token == "NE") {
return("not equal to")
}
if (token == "'!'") {
return("not")
}
if (token == "AND") {
return("and")
}
if (token == "OR") {
return("or")
}
if (token == "AND2") {
return("double-and")
}
if (token == "OR2") {
return("double-or")
}
# Braces
if (token == "'('") {
return("open paren")
}
if (token == "')'") {
return("close paren")
}
if (token == "'{'") {
return("open curly brace")
}
if (token == "'}'") {
return("close curly brace")
}
if (token == "LBB") {
return("open double-square bracket")
}
if (token == "'['") {
return("open square bracket")
}
if (token == "']'") {
return("close square bracket")
}
# Assignment
if (token == "LEFT_ASSIGN" | token == "EQ_ASSIGN") {
return("gets")
}
if (token == "RIGHT_ASSIGN") {
return("into")
}
# Infix operators
if (token == "SPECIAL" & text == "%in%") {
return("matches")
}
if (token == "SPECIAL" & text == "%>%") {
return("then")
}
# Functions
if (token == "SYMBOL_FUNCTION_CALL") {
if (text == "c") {
return("a vector of")
}
return(paste(function_call, text, function_call_end))
}
# Definition operator
if (token == "'~'") {
return("by")
}
# Help
if (token == "'?'") {
return("help for")
}
# Namespace
if (token == "NS_GET") { # '::'
return("double-colon")
}
if (token == "NS_GET_INT") { # ':::'
return("triple-colon")
}
# Unnamed tokens
if (grepl("SYMBOL", token)) {
return(text)
}
if (token == "STR_CONST") {
return(paste0("string ", text))
}
if (token == "expr") {
return("")
}
return(text)
}