forked from ropensci/jqr
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
307 lines (218 loc) · 5.59 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
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
303
304
305
306
307
jqr
=======
```{r echo=FALSE}
knitr::opts_chunk$set(
comment = "#>",
collapse = TRUE,
warning = FALSE,
message = FALSE
)
```
[![Build Status](https://travis-ci.org/ropensci/jqr.png?branch=master)](https://travis-ci.org/ropensci/jqr)
[![Coverage Status](https://coveralls.io/repos/ropensci/jqr/badge.svg?branch=master)](https://coveralls.io/r/ropensci/jqr?branch=master)
R interface to jq http://stedolan.github.io/jq/
## Install
Get dependencies not on CRAN
```{r eval=FALSE}
devtools::install_github("vsbuffalo/rivr")
```
To install `jqr`, after cloning the repo the first time, run (from the command line)
```
./bootstrap.R
```
which will download the 1.4 release of [jq](http://stedolan.github.io/jq/). This does not need to be run on subsequent runs, and will stop being required once [this issue](https://github.com/ropensci/jqr/issues/1) is resolved.
```{r}
library("jqr")
```
## Interfaces
### low level
There's a low level interface in which you can execute `jq` code just as you would on the command line:
```{r}
str <- '[{
"foo": 1,
"bar": 2
},
{
"foo": 3,
"bar": 4
},
{
"foo": 5,
"bar": 6
}]'
```
```{r}
jq_(str, ".[]")
```
```{r}
jq_(str, "[.[] | {name: .foo} | keys]")
```
### high level
The other is higher level, and uses a suite of functions to construct queries. Queries are constucted, then excuted with the function `jq()`.
Examples:
Index
```{r}
x <- '[{"message": "hello", "name": "jenn"}, {"message": "world", "name": "beth"}]'
x %>% index() %>% jq
```
Sort
```{r}
'[8,3,null,6]' %>% sort %>% jq
```
reverse order
```{r}
'[1,2,3,4]' %>% reverse %>% jq
```
Show the query to be used using `peek()`
```{r}
'[1,2,3,4]' %>% reverse %>% peek
```
#### string operations
join
```{r}
'["a","b,c,d","e"]' %>% join %>% jq
'["a","b,c,d","e"]' %>% join(`;`) %>% jq
```
ltrimstr
```{r}
'["fo", "foo", "barfoo", "foobar", "afoo"]' %>% index() %>% ltrimstr(foo) %>% jq
```
rtrimstr
```{r}
'["fo", "foo", "barfoo", "foobar", "foob"]' %>% index() %>% rtrimstr(foo) %>% jq
```
startswith
```{r}
'["fo", "foo", "barfoo", "foobar", "barfoob"]' %>% index %>% startswith(foo) %>% jq
```
endswith
```{r}
'["fo", "foo", "barfoo", "foobar", "barfoob"]' %>% index %>% endswith(foo) %>% jq
```
tojson, fromjson, tostring
```{r}
'[1, "foo", ["foo"]]' %>% index %>% tostring %>% jq
'[1, "foo", ["foo"]]' %>% index %>% tojson %>% jq
'[1, "foo", ["foo"]]' %>% index %>% tojson %>% fromjson %>% jq
```
contains
```{r}
'"foobar"' %>% contains("bar") %>% jq
```
unique
```{r}
'[1,2,5,3,5,3,1,3]' %>% unique %>% jq
```
#### types
get type information for each element
```{r}
'[0, false, [], {}, null, "hello"]' %>% types %>% jq
'[0, false, [], {}, null, "hello", true, [1,2,3]]' %>% types %>% jq
```
select elements by type
```{r}
'[0, false, [], {}, null, "hello"]' %>% index() %>% type(booleans) %>% jq
```
#### key operations
get keys
```{r}
str <- '{"foo": 5, "bar": 7}'
str %>% keys() %>% jq
```
delete by key name
```{r}
str %>% del(bar) %>% jq
```
check for key existence
```{r}
str3 <- '[[0,1], ["a","b","c"]]'
str3 %>% haskey(2) %>% jq
str3 %>% haskey(1,2) %>% jq
```
Select variables by name, and rename
```{r}
'{"foo": 5, "bar": 7}' %>% select(a = .foo) %>% jq
```
More complicated `select()`, using the included dataset `githubcommits`
```{r}
githubcommits %>%
index() %>%
select(sha = .sha, name = .commit.committer.name) %>%
jq(TRUE)
```
#### Maths
```{r}
'{"a": 7}' %>% do(.a + 1) %>% jq
'{"a": [1,2], "b": [3,4]}' %>% do(.a + .b) %>% jq
'{"a": [1,2], "b": [3,4]}' %>% do(.a - .b) %>% jq
'{"a": 3}' %>% do(4 - .a) %>% jq
'["xml", "yaml", "json"]' %>% do('. - ["xml", "yaml"]') %>% jq
'5' %>% do(10 / . * 3) %>% jq
```
comparisons
```{r}
'[5,4,2,7]' %>% index() %>% do(. < 4) %>% jq
'[5,4,2,7]' %>% index() %>% do(. > 4) %>% jq
'[5,4,2,7]' %>% index() %>% do(. <= 4) %>% jq
'[5,4,2,7]' %>% index() %>% do(. >= 4) %>% jq
'[5,4,2,7]' %>% index() %>% do(. == 4) %>% jq
'[5,4,2,7]' %>% index() %>% do(. != 4) %>% jq
```
length
```{r}
'[[1,2], "string", {"a":2}, null]' %>% index %>% length %>% jq
```
sqrt
```{r}
'9' %>% sqrt %>% jq
```
floor
```{r}
'3.14159' %>% floor %>% jq
```
find minimum
```{r}
'[5,4,2,7]' %>% min %>% jq
'[{"foo":1, "bar":14}, {"foo":2, "bar":3}]' %>% min %>% jq
'[{"foo":1, "bar":14}, {"foo":2, "bar":3}]' %>% min(foo) %>% jq
'[{"foo":1, "bar":14}, {"foo":2, "bar":3}]' %>% min(bar) %>% jq
```
find maximum
```{r}
'[5,4,2,7]' %>% max %>% jq
'[{"foo":1, "bar":14}, {"foo":2, "bar":3}]' %>% max %>% jq
'[{"foo":1, "bar":14}, {"foo":2, "bar":3}]' %>% max(foo) %>% jq
'[{"foo":1, "bar":14}, {"foo":2, "bar":3}]' %>% max(bar) %>% jq
```
#### Combine into valid JSON
`jq` sometimes creates pieces of JSON that are valid in themselves, but together are not.
`combine()` is a way to make valid JSON.
This outputs a few pieces of JSON
```{r}
(x <- githubcommits %>%
index() %>%
select(sha = .sha, name = .commit.committer.name) %>%
jq(TRUE))
```
Use `combine()` to put them together.
```{r}
combine(x)
```
#### Streaming
Write `mtcars` to a temporary file
```{r}
writeLines(jsonlite::toJSON(mtcars, collapse = FALSE),
tmp <- tempfile())
```
Build a file iterator
```{r}
it_f <- rivr::file_iterator(tmp)
it_j <- jq_iterator(it_f, '{cyl: ."cyl"}')
replicate(NROW(mtcars), it_j$yield())
```
> the streaming bit is a [work in progress](https://github.com/ropensci/jqr/issues/8)
## Meta
* Please [report any issues or bugs](https://github.com/ropensci/jqr/issues).
* License: MIT
* Get citation information for `jqr` in R doing `citation(package = 'jqr')`
[![rofooter](http://ropensci.org/public_images/github_footer.png)](http://ropensci.org)