-
Notifications
You must be signed in to change notification settings - Fork 0
/
hs_resource.R
697 lines (635 loc) · 23 KB
/
hs_resource.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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
# nolint start
#' @title List resources
#'
#' @description
#' This is the primary function for querying the
#' HydroShare API `/hsapi/resource` endpoint. It will return
#' a [tibble][tibble::tibble-package] corresponding to the
#' given parameters. Endpoint is chosen algorithmically based
#' on passed parameters.
#'
#' @param ... See **details**.
#'
#' @return
#' A [tibble][tibble::tibble-package]. See **details**.
#'
#' @details
#' Below is a sectioned list of all possible parameters
#' that `hs_resource` can parse, and the
#' corresponding HydroShare API endpoint(s)/functions used.
#'
#' Parameters marked with an asterisk (*) are required for
#' that endpoint.
#'
#' ## Searching Resources (`hs_search`)
#'
#' ### Endpoint:
#'
#' - **/hsapi/resource/search**
#'
#' ### Parameters:
#'
#' Parameter | Data/Object Type | Description
#' ------------------ | ------------------ | ---------------------------------------------
#' `page` | `integer` | A page number within the paginated result set.
#' `count` | `integer` | Number of results to return per page.
#' `creator` | `character` | The first author (name or email)
#' `author` | `character vector` | List of authors (name or email)
#' `group` | `character` | A group name (requires `edit_permissions = TRUE`)
#' `user` | `character` | Viewable by user (name or email)
#' `owner` | `character` | Owned by user (name or email)
#' `from_date` | `Date` | To get a list of resources created on or after this date
#' `to_date` | `Date` | To get a list of resources created on or before this date
#' `subject` | `character vector` | Comma separated list of subjects
#' `full_text_search` | `character` | Get a list of resources with this text
#' `edit_permission` | `logical` | Filter by edit permissions of user/group/owner?
#' `published` | `logical` | Filter by published resources?
#' `type` | `character vector` | List of resources of the specified resource types. See below possible values.
#' `coverage_type` | `character` | To get a list of resources that fall within the specified tial coverage boundary. Either: "box" or "point"
#' `coordinates` | `character vector` | List of spatial coordinates in the form of (north, south, t, west)
#' `include_obselete` | `logical` | Include replaced resources?
#'
#' For available resource types, see \link{hs_types}.
#'
#' ## Getting Resource Information by ID (`hs_sysmeta`)
#'
#' ### Endpoints:
#'
#' - **/hsapi/resource/{id}/sysmeta**
#'
#' ### Parameters:
#'
#' Parameters | Data/Object Type | Description
#' ---------- | ---------------- | -----------
#' `id`* | `character` | Resource Alphanumeric ID
#'
#' ### Return:
#'
#' Column | Description
#' ---------------------- | ---------------------
#' `resource_title` | Title of the resource
#' `resource_type` | Resource type
#' `resource_id` | ID of the resource
#' `abstract` | Resource abstract
#' `authors` | Authors of resource
#' `creator` | Creator of resource
#' `doi` | Resource DOI ID
#' `public` | Indicates if resource if public
#' `discoverable` | Indicates if resource is discoverable
#' `shareable` | Indicates if resource is shareable
#' `immutable` | Indicates if resource is immutable
#' `published` | Indicates if resource is published
#' `date_created` | Date resource was created
#' `date_last_updated` | Date resource was last updated
#' `bag_url` | URL to resource download, can be passed to \code{\link{download.file}}
#' `science_metadata_url` | URL to science metadata
#' `resource_map_url` | URL to resource map
#' `resource_url` | URL to resource
#' `content_types` | Resource content types, see \code{\link{hs_content_types}}
#'
#' ## Getting Resource Access Permissions (`hs_access`)
#'
#' ### Endpoint:
#'
#' - **/hsapi/resource/{id}/access**
#'
#' ### Parameters:
#'
#' Parameter | Data/Object Type | Description
#' --------- | ---------------- | -----------
#' `id`* | `character` | Resource Alphanumeric ID
#' `access`* | `logical` | Must be `TRUE` for access query
#'
#' ### Return:
#'
#' Column | Description
#' ----------- | -----------
#' `id` | Resource Alphanumeric ID
#' `privilege` | User's privilege level
#' `user` | User to be granted privilege
#' `resource` | Resource to which privilege applies
#' `grantor` | Grantor of privilege
#'
#' ## Getting Resource File List (`hs_files`)
#'
#' ### Endpoint:
#'
#' - **/hsapi/resource/{id}/files**
#'
#' ### Parameters:
#'
#' Parameter | Data/Object Type | Description
#' --------- | ---------------- | -----------
#' `id`* | `character` | Resource Alphanumeric ID
#' `files`* | `logical` | Must be `TRUE` for files query
#' `page` | `integer` | Page of results to return
#' `count` | `integer` | Number of files to return per page
#'
#' ### Return:
#'
#' Column | Description
#' ------------------- | -----------
#' `file_name` | The filename, including the path
#' `url` | The url to download the file
#' `size` | The size of the file
#' `content_type` | The content type of the file
#' `logical_file_type` | The logical file type
#' `modified_time` | The last modified time of the file
#' `checksum` | The file's checksum
#'
#' ## Getting Resource Folder(s) (`hs_folder`)
#'
#' ### Endpoint:
#'
#' - **/hsapi/resource/{id}/folders/{pathname}/**
#'
#' ### Parameters:
#'
#' Parameter | Data/Object Type | Description
#' ----------- | ---------------- | -----------
#' `id`* | `character` | Resource Alphanumeric ID
#' `pathname`* | `character` | Path to folder in resource's contents
#'
#' ### Return:
#'
#' Column | Description
#' ------------- | -----------
#' `resource_id` | Resource Alphanumeric ID
#' `path` | Path to folder in resource's contents
#' `contents` | Nested `tibble` with files and folders within `path`
#'
#' ## Getting Resource Science Metadata (`hs_scimeta`)
#'
#' ### Endpoints:
#'
#' - **/hsapi/resource/{id}/scimeta**
#'
#' ### Parameters:
#'
#' Parameter | Data/Object Type | Description
#' ---------- | ---------------- | -----------
#' `id`* | `character` | Resource Alphanumeric ID
#' `scimeta`* | `logical` | Must be `TRUE` for scimeta query
#'
#' ### Return:
#'
#' Column | Description
#' ---------- | -----------
#' `id` | Resource Alphanumeric ID
#' `title` | Resource Title
#' `citation` | Resource Bibliography Citation
#' `creators` | Nested `tibble` of resource creator(s)
#' `sources` | Nested `tibble` of resource source(s)
#' `metadata` | Nested `tibble` with additional resource metadata
#'
#' @importFrom magrittr %>%
#' @export
# nolint end
hs_resource <- function(...) {
path <- handle_params(...)
response <- switch(
path,
search = hs_search(...),
files = hs_files(...),
folder = hs_folder(...),
access = hs_access(...),
scimeta = hs_scimeta(...),
sysmeta = hs_sysmeta(...)
)
response
}
#' @title List Content Types
#' @return
#' A character vector of content types.
#'
#' As of 2/24/2021, the types returned will be:
#' - `GenericLogicalFile`
#' - `GeoRasterLogicalFile`
#' - `NetCDFLogicalFile`
#' - `GeoFeatureLogicalFile`
#' - `RefTimeseriesLogicalFile`
#' - `TimeSeriesLogicalFile`
#' - `FileSetLogicalFile`
#'
#' @export
hs_content_types <- function() {
request <- hsapi_request(path = "resource/content_types/")
httr::stop_for_status(request)
content <- httr::content(request) %>%
unlist() %>%
unname()
content
}
# nolint start
#' @title Search HydroShare Resources using solr conventions.
#' @param page (`integer`) A page number within the paginated result set.
#' @param count (`integer`) Number of results to return per page.
#' @param text (`character`) Search across all Resource Fields
#' @param author (`character`) Search by author
#' @param ... Additional parameters passed to the HydroShare API.
#' See **details**.
#' @return A list with `.next`, `.prev`, and `results` attributes.
#' `results` returns a [tibble][tibble::tibble-package].
#' @details
#'
#' ## Additional Parameters:
#'
#' Parameter | Data/Object Type | Description
#' --------------- | ------------------ | ---------------------
#' `contributor` | `character vector` | Search by contributor(s)
#' `subject` | `character vector` | Search within subject keywords
#' `abstract` | `character` | Search within the abstract
#' `resource_type` | `character` | Search by resource type
#' `content_type` | `character vector` | Search by content type(s)
#' `coverage_type` | `character vector` | Search by coverage type(s) (point, box, period)
#' `availability` | `character vector` | Search by availabilities (discoverable, public, published)
#' `created` | `Date` | Search by created date
#' `modified` | `Date` | Search by modified date
#' `start_date` | `Date` | Search by start date
#' `end_date` | `Date` | Search by end date
#' `east` | `numeric` | Search by location or box center east longitude
#' `north` | `numeric` | Search by location or box center north latitude
#' `eastlimit` | `numeric` | Search by east limit longitude
#' `westlimit` | `numeric` | Search by west limit longitude
#' `northlimit` | `numeric` | Search by north limit latitude
#' `southlimit` | `numeric` | Search by south limit latitude
#'
#' @importFrom stringr str_extract_all
#' @importFrom stringr str_trim
#' @importFrom magrittr extract
#' @importFrom rlang .data
#' @export
# nolint end
hs_search <- function(page = NULL, count = NULL,
text = NULL, author = NULL, ...) {
# Prevents R CMD Check note about non-standard
# evaluation with magrittr pipes
. <- NULL
request <- hsapi_request(
path = "resource/search",
query = list(
page = page,
count = count,
text = text,
author = author,
...
)
)
httr::stop_for_status(request)
content <- httr::content(request)
tidy_content <- content$results %>%
lapply(FUN = function(item) {
tibble::tibble(
text = handle_null(item$text),
author = handle_null(item$author),
abstract = handle_null(item$abstract),
contributor = handle_null(item$contributor, TRUE),
subject = handle_null(item$subject, TRUE),
availability = handle_null(item$availability, TRUE),
created = handle_null(item$created),
modified = handle_null(item$modified),
coverage_type = handle_null(item$coverage_type, TRUE),
northlimit = handle_null(item$northlimit),
eastlimit = handle_null(item$eastlimit),
southlimit = handle_null(item$southlimit),
westlimit = handle_null(item$westlimit),
start_date = handle_null(item$start_date),
end_date = handle_null(item$end_date),
resource_type = handle_null(item$resource_type),
content_type = handle_null(item$content_type, TRUE)
)
}) %>%
dplyr::bind_rows()
split_text <-
lapply(
X = tidy_content$text,
FUN = function(res_text) {
split_string <-
stringr::str_split(res_text, "\n")[[1]] %>%
magrittr::extract(which(. != "" & . != " ")) %>%
stringr::str_trim() %>%
stringr::str_split(" ") %>%
unlist() %>%
stringr::str_trim() %>%
magrittr::extract(1:3)
if (nchar(split_string[1]) == 32) {
c(
id = split_string[1],
doi = NA,
title = split_string[2]
)
} else if (stringr::str_detect(split_string[1], "doi")) {
temp <- stringr::str_split_fixed(split_string[1], " ", 3)
c(
id = temp[, 1],
doi = temp[, 2],
title = temp[, 3]
)
}
}
)
tidier_content <-
dplyr::mutate(
tidy_content,
id = stringr::str_trim(lapply(split_text, `[[`, "id")),
doi = stringr::str_trim(lapply(split_text, `[[`, "doi")),
title = stringr::str_trim(lapply(split_text, `[[`, "title"))
) %>%
dplyr::select(-.data$text) %>%
dplyr::relocate(.data$id, .data$title) %>%
tidyr::nest(
metadata = c(
# .data$doi,
.data$created,
.data$modified,
.data$start_date,
.data$end_date,
.data$resource_type
),
geodata = c(
.data$coverage_type,
.data$northlimit,
.data$eastlimit,
.data$southlimit,
.data$westlimit
)
)
response <- list()
response$".next" <- handle_null(content$"next")
response$".prev" <- handle_null(content$"previous")
response$results <- tidier_content
response
}
#' @title List Resource Types
#' @return
#' A character vector containing the elements:
#' - `GenericResource`
#' - `RasterResource`
#' - `RefTimeSeriesResource`
#' - `TimeSeriesResource`
#' - `NetcdfResource`
#' - `ModelProgramResource`
#' - `ModelInstanceResource`
#' - `ToolResource`
#' - `SWATModelInstanceResource`
#' - `GeographicFeatureResource`
#' - `ScriptResource`
#' - `CollectionResource`
#' - `MODFLOWModelInstanceResource`
#' - `CompositeResource`
#' @export
hs_types <- function() {
request <- hsapi_request("resource/types/")
httr::stop_for_status(request)
content <- httr::content(request) %>%
unlist() %>%
unname()
content
}
# nocov start
#' @title Access Resource Permissions
#' @param id Resource ID
#' @param ... Unused
#' @return A [tibble][tibble::tibble-package].
#' @export
hs_access <- function(id, ...) {
if (missing(id)) rlang::abort("(hs_access) id required.")
request <- hsapi_request(
path = paste0(
"resource/",
id,
"/access/"
)
)
httr::stop_for_status(request)
content <- httr::content(request)
tibble::tibble(
id = handle_null(content$id),
privilege = handle_null(content$privilege),
user = handle_null(content$user),
resource = handle_null(content$resource),
grantor = handle_null(content$grantor)
)
}
# nocov end
#' @title Get Resource Files
#' @param id Resource ID
#' @param page Page of results to return
#' @param count Number of files to return per page
#' @param ... Unused
#' @return A [tibble][tibble::tibble-package].
#' @export
hs_files <- function(id, page = NULL, count = NULL, ...) {
if (missing(id)) rlang::abort("(hs_files) id required.")
request <- hsapi_request(
path = paste0(
"resource/",
id,
"/files/"
),
query = list(
page = page,
count = count
)
)
httr::stop_for_status(request)
content <- httr::content(request)
tidy_content <-
content$results %>%
lapply(FUN = function(item) {
tibble::tibble(
file_name = handle_null(item$file_name),
url = handle_null(item$url),
size = handle_null(item$size),
content_type = handle_null(item$content_type),
logical_file_type = handle_null(item$logical_file_type),
modified_time = handle_null(item$modified_time),
checksum = handle_null(item$checksum)
)
}) %>%
dplyr::bind_rows()
response <- list()
response$".next" <- handle_null(content$"next")
response$".prev" <- handle_null(content$"previous")
response$results <- tidy_content
response
}
#' @title Get Resource Folder
#' @param id Resource ID
#' @param pathname Path to folder in resource's contents
#' @param ... Unused
#' @return A [tibble][tibble::tibble-package].
#' @importFrom rlang .data
#' @importFrom tidyr nest unpack
#' @importFrom tidyselect everything
#' @export
hs_folder <- function(id, pathname, ...) {
if (missing(id) | missing(pathname)) {
rlang::abort(
"(hs_folder) Both id and pathname are required."
)
}
request <- hsapi_request(
path = paste0(
"resource/",
id,
"/folders/",
pathname
)
)
httr::stop_for_status(request)
content <- httr::content(request)
files <- tibble::tibble(
item = unlist(content$files),
type = "files"
)
folders <- tibble::tibble(
item = unlist(content$folders),
type = "folder"
)
file_col <- suppressWarnings(is.null(files$item))
fold_col <- suppressWarnings(is.null(folders$item))
if (file_col & fold_col) {
return(NA)
}
folder_contents <-
if (!(file_col | fold_col)) {
dplyr::bind_rows(files, folders)
} else if (fold_col) {
files
} else {
folders
}
response <-
tibble::tibble(
resource_id = content$resource_id,
path = content$path,
folder_contents = folder_contents
) %>%
tidyr::nest(contents = .data$folder_contents)
response$contents <-
lapply(response$contents,
tidyr::unpack,
tidyselect::everything())
response
}
#' @title Get Resource Science Metadata
#' @param id Resource ID
#' @param ... Unused
#' @return A [tibble][tibble::tibble-package].
#' @importFrom xml2 read_xml as_list
#' @importFrom tidyselect everything
#' @export
hs_scimeta <- function(id, ...) {
if (missing(id)) rlang::abort("(hs_scimeta) id required.")
request <- hsapi_request(
path = paste0(
"resource/",
id,
"/scimeta/"
)
)
httr::stop_for_status(request)
content <- httr::content(request, as = "raw")
xml <- xml2::read_xml(content)
res <- xml2::as_list(xml)$RDF[[1]]
res_title <- res$title[[1]]
res_cite <- res$bibliographicCitation[[1]]
res_lang <- res$language[[1]]
res_type <- paste(unlist(res$type$Description$label),
collapse = ", ")
res_subj <- paste(unlist(res[which(names(res) == "subject")]),
collapse = ", ")
res_id <- attr(res$identifier$Description$hydroShareIdentifier,
which = "resource")
mod_date <- res[which(names(res) == "date")][[1]]$modified$value
cre_date <- res[which(names(res) == "date")][[2]]$created$value
creators <- res[which(names(res) == "creator")] %>%
lapply(FUN = function(item) {
unlist(item$Description)
}) %>%
dplyr::bind_rows()
metadata <- tibble::tibble(languages = res_lang,
types = res_type,
subjects = res_subj,
modified = mod_date,
created = cre_date)
response <-
tibble::tibble(
id = res_id,
title = res_title,
citation = res_cite,
creators = creators,
metadata = metadata
) %>%
tidyr::nest(
creators = creators,
metadata = metadata
)
response$creators <- lapply(response$creators,
tidyr::unpack,
dplyr::everything())
response$metadata <- lapply(response$metadata,
tidyr::unpack,
dplyr::everything())
if (any(names(res) == "source")) {
sources <- res[which(names(res) == "source")] %>%
lapply(FUN = function(item) {
attr(
item$Description$isDerivedFrom,
which = "resource"
)
}) %>%
unlist() %>%
unname() %>%
tibble::as_tibble() %>%
dplyr::rename(sources = .data$value)
response <- dplyr::mutate(sources = sources) %>%
tidyr::nest(sources = sources)
response$sources <- lapply(response$sources,
tidyr::unpack,
dplyr::everything())
}
response
}
#' @title Get Resource System Metadata by ID
#' @param id Alphanumeric HydroShare Resource ID
#' @param ... Unused
#' @return A [tibble][tibble::tibble-package].
#' @export
hs_sysmeta <- function(id, ...) {
if (missing(id)) rlang::abort("(hs_sysmeta) id required.")
request <- hsapi_request(
path = paste0(
"resource/",
id,
"/sysmeta/"
)
)
httr::stop_for_status(request)
item <- httr::content(request)
response <-
tibble::tibble(
resource_title = handle_null(item$resource_title),
resource_type = handle_null(item$resource_type),
resource_id = handle_null(item$resource_id),
abstract = handle_null(item$abstract),
authors = handle_null(item$authors, TRUE),
creator = handle_null(item$creator),
doi = handle_null(item$doi),
public = handle_null(item$public),
discoverable = handle_null(item$discoverable),
shareable = handle_null(item$shareable),
immutable = handle_null(item$immutable),
published = handle_null(item$published),
date_created = handle_null(item$date_created),
date_last_updated = handle_null(item$date_last_updated),
bag_url = handle_null(item$bag_url),
science_metadata_url = handle_null(item$science_metadata_url),
resource_map_url = handle_null(item$resource_map_url),
resource_url = handle_null(item$resource_url),
content_types = handle_null(item$content_types, TRUE)
) %>%
dplyr::bind_rows()
response
}