all sites function improvements

NAMESPACE

@@ -81,6 +81,7 @@ importFrom(httr,GET)
 importFrom(httr,POST)
 importFrom(httr,add_headers)
 importFrom(httr,content)
+importFrom(httr,modify_url)
 importFrom(httr,status_code)
 importFrom(janitor,adorn_totals)
 importFrom(janitor,make_clean_names)

R/get_all_sites.R

@@ -8,14 +8,21 @@
 #'
 #' @param auth_response Authentication response object obtained from the OpenSpecimen API.
 #'
-#' @return A data table containing the details of all sites, or NULL if an error occurs.
+#' @param startAt Starting row of the result (optional).
+#' @param maxResults Maximum number of records to fetch (optional). By default, it will be 100.
+#' @param name Result contains all sites which have a name containing the given value (optional).
+#' @param exactMatch If TRUE, considers the name parameter as an exact match with the site name (optional).
+#' @param institute Result contains all sites which belong to the given institute (optional).
+#' @importFrom httr GET add_headers modify_url
+#' @return A data frame containing the details of all sites, or NULL if an error occurs.
+#'
 #'
 #' @seealso \code{\link{auth_os}}, \code{\link{parse_os_response}}, \code{\link{parse_all_sites}}
-#' @note [see api docs for more details:](https://openspecimen.atlassian.net/wiki/spaces/CAT/pages/1115685/Get+All+Sites)
+#'
 #' @export
 #' @examples
 #' #get_all_sites()
-get_all_sites <- function(auth_response) {
+get_all_sites <- function(auth_response, startAt = NULL, maxResults = 500, name = NULL, exactMatch = FALSE, institute = NULL) {
 
   # URL to get all sites
   # For more details, refer to: https://openspecimen.atlassian.net/wiki/spaces/CAT/pages/1115685/Get+All+Sites
@@ -27,6 +34,23 @@ get_all_sites <- function(auth_response) {
     "X-OS-API-TOKEN" = auth_response$auth_response$token
   )
 
+  # Construct query parameters based on provided arguments
+  query_params <- list(
+    startAt = startAt,
+    maxResults = maxResults,
+    name = name,
+    exactMatch = exactMatch,
+    institute = institute
+  )
+
+  # Remove NULL parameters
+  query_params <- query_params[!sapply(query_params, is.null)]
+
+  # Append query parameters to the URL
+  if (length(query_params) > 0) {
+    url <- modify_url(url, query = query_params)
+  }
+
   # Make the GET request for the query
   response <- GET(url = url, config = headers, encode = "json")
 
@@ -43,3 +67,4 @@ get_all_sites <- function(auth_response) {
 
 
 
+

dev/OpenSpecimenAPI.Rmd

@@ -1211,12 +1211,19 @@ test_that("get_bulk_order_items works", {
 #'
 #' @param auth_response Authentication response object obtained from the OpenSpecimen API.
 #'
-#' @return A data table containing the details of all sites, or NULL if an error occurs.
+#' @param startAt Starting row of the result (optional).
+#' @param maxResults Maximum number of records to fetch (optional). By default, it will be 100.
+#' @param name Result contains all sites which have a name containing the given value (optional).
+#' @param exactMatch If TRUE, considers the name parameter as an exact match with the site name (optional).
+#' @param institute Result contains all sites which belong to the given institute (optional).
+#' @importFrom httr GET add_headers modify_url
+#' @return A data frame containing the details of all sites, or NULL if an error occurs.
+#'
 #'
 #' @seealso \code{\link{auth_os}}, \code{\link{parse_os_response}}, \code{\link{parse_all_sites}}
-#' @note [see api docs for more details:](https://openspecimen.atlassian.net/wiki/spaces/CAT/pages/1115685/Get+All+Sites)
+#'
 #' @export
-get_all_sites <- function(auth_response) {
+get_all_sites <- function(auth_response, startAt = NULL, maxResults = 500, name = NULL, exactMatch = FALSE, institute = NULL) {
   
   # URL to get all sites
   # For more details, refer to: https://openspecimen.atlassian.net/wiki/spaces/CAT/pages/1115685/Get+All+Sites
@@ -1228,6 +1235,23 @@ get_all_sites <- function(auth_response) {
     "X-OS-API-TOKEN" = auth_response$auth_response$token
   )
   
+  # Construct query parameters based on provided arguments
+  query_params <- list(
+    startAt = startAt,
+    maxResults = maxResults,
+    name = name,
+    exactMatch = exactMatch,
+    institute = institute
+  )
+  
+  # Remove NULL parameters
+  query_params <- query_params[!sapply(query_params, is.null)]
+  
+  # Append query parameters to the URL
+  if (length(query_params) > 0) {
+    url <- modify_url(url, query = query_params)
+  }
+  
   # Make the GET request for the query
   response <- GET(url = url, config = headers, encode = "json")
   
@@ -1244,6 +1268,7 @@ get_all_sites <- function(auth_response) {
 
 
 
+
 ```