-
Notifications
You must be signed in to change notification settings - Fork 0
/
get_performance_metrics.R
180 lines (156 loc) · 6.02 KB
/
get_performance_metrics.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
get_performance <- function(resource,
limit = 20L,
verbose = FALSE,
warnings = TRUE,
progress_bar = TRUE) {
tbl_json <- get(resource_url = resource,
limit = limit,
verbose = verbose,
warnings = warnings,
progress_bar = progress_bar)
tidy_tbls <- as_tidy_tables_performance_metrics(tbl_json)
return(tidy_tbls)
}
get_performance_all <- function(limit = 20L, verbose = FALSE, warnings = TRUE, progress_bar = TRUE) {
resource <- '/rest/performance/all'
get_performance(resource = resource,
limit = limit,
verbose = verbose,
warnings = warnings,
progress_bar = progress_bar)
}
get_performance_by_ppm_id <- function(ppm_id, limit = 20L, verbose = FALSE, warnings = TRUE, progress_bar = TRUE) {
resource <- '/rest/performance'
resource_urls <- sprintf("%s/%s", resource, ppm_id)
purrr::map(
resource_urls,
get_performance,
limit = limit,
warnings = warnings,
verbose = verbose,
progress_bar = progress_bar
) %>%
purrr::pmap(dplyr::bind_rows)
}
get_performance_by_pgs_id <- function(pgs_id, limit = 20L, verbose = FALSE, warnings = TRUE, progress_bar = TRUE) {
resource <- '/rest/performance/search'
resource_urls <- sprintf("%s?pgs_id=%s", resource, pgs_id)
purrr::map(
resource_urls,
get_performance,
limit = limit,
warnings = warnings,
verbose = verbose,
progress_bar = progress_bar
) %>%
purrr::pmap(dplyr::bind_rows)
}
#' Get PGS Catalog Performance Metrics
#'
#' Retrieves performance metrics via the PGS Catalog REST API. The REST
#' API is queried multiple times with the criteria passed as arguments (see
#' below). By default all performance metrics that match the criteria supplied in the
#' arguments are retrieved: this corresponds to the default option
#' \code{set_operation} set to \code{'union'}. If you rather have only the
#' associations that match simultaneously all criteria provided, then set
#' \code{set_operation} to \code{'intersection'}.
#'
#' Please note that all search criteria are vectorised, thus allowing for batch
#' mode search.
#'
#' @param ppm_id A character vector of PGS Catalog performance metrics accession
#' identifiers.
#' @param pgs_id A \code{character} vector of PGS Catalog score accession
#' identifiers.
#' @param set_operation Either \code{'union'} or \code{'intersection'}. This
#' tells how performance metrics retrieved by different criteria should be combined:
#' \code{'union'} binds together all results removing duplicates and
#' \code{'intersection'} only keeps same performance metrics found with different
#' criteria.
#' @param interactive A logical. If all performance metrics are requested, whether to ask
#' interactively if we really want to proceed.
#' @param verbose A \code{logical} indicating whether the function should be
#' verbose about the different queries or not.
#' @param warnings A \code{logical} indicating whether to print warnings, if any.
#' @param progress_bar Whether to show a progress bar as the queries are
#' performed.
#'
#' @return A \linkS4class{performance_metrics} object.
#' @examples
#' \dontrun{
#' # Get performance metrics catalogued with identifier 'PPM000001'
#' get_performance_metrics(ppm_id = 'PPM000001')
#'
#' # Get performance metrics associated with polygenic score id 'PGS000001'
#' get_performance_metrics(pgs_id = 'PGS000001')
#'
#' # To retrieve all catalogued performed metrics in PGS Catalog you simply
#' # leave the parameters `ppm_id` and `pgs_id` as `NULL`.
#' get_performance_metrics()
#' }
#'
#' @export
get_performance_metrics <- function(
ppm_id = NULL,
pgs_id = NULL,
set_operation = 'union',
interactive = TRUE,
verbose = FALSE,
warnings = TRUE,
progress_bar = TRUE) {
if(!(rlang::is_scalar_character(set_operation) && set_operation %in% c('union', 'intersection')))
stop("set_operation must be either 'union' or 'intersection'")
if(!(rlang::is_scalar_logical(verbose) && verbose %in% c(TRUE, FALSE)))
stop("verbose must be either TRUE or FALSE")
if(!(rlang::is_scalar_logical(warnings) && warnings %in% c(TRUE, FALSE)))
stop("warnings must be either TRUE or FALSE")
list_of_ppm <- list()
if (!rlang::is_null(ppm_id))
list_of_ppm[['get_performance_by_ppm_id']] <-
get_performance_by_ppm_id(ppm_id = ppm_id,
verbose = verbose,
warnings = warnings,
progress_bar = progress_bar) %>%
coerce_to_s4_performance_metrics()
if (!rlang::is_null(pgs_id))
list_of_ppm[['get_performance_by_pgs_id']] <-
get_performance_by_pgs_id(pgs_id = pgs_id,
verbose = verbose,
warnings = warnings,
progress_bar = progress_bar) %>%
coerce_to_s4_performance_metrics()
# If no criteria have been passed, i.e. all are NULL then got fetch all
# Performance Metrics.
if(rlang::is_empty(list_of_ppm)) {
msg1 <- "You are about to download all Performance Metrics from the PGS Catalog.\nThis might take a while."
msg2 <- 'Returning an empty performance_metrics object!'
msg3 <- 'OK! Getting all Performance Metrics then. This is going to take a while...'
if(interactive)
default_answer = NULL # i.e., use interactive mode.
else
default_answer = 'y'
if (sure(
before_question = msg1,
after_saying_no = msg2,
after_saying_yes = msg3,
default_answer = default_answer
))
return(
coerce_to_s4_performance_metrics(
get_performance_all(
verbose = verbose,
warnings = warnings,
progress_bar = progress_bar
))
)
else
return(coerce_to_s4_performance_metrics(NULL))
} else {
if (identical(set_operation, "union")) {
return(purrr::reduce(list_of_ppm, union))
}
if (identical(set_operation, "intersection")) {
return(purrr::reduce(list_of_ppm, intersect))
}
}
}