Fixed issues for CRAN submission.

DESCRIPTION

@@ -25,9 +25,7 @@ Authors@R:
            role = c("aut", "cre"),
            email = "luca.belmonte@efsa.europa.eu",
            comment = c(ORCID = "0000-0002-7977-9170")))
-Description: Provides a pool of functions to query 'DistillerSR' through its
-  APIs. It features authentication and utilities to retrieve data from
-  'DistillerSR' projects and reports. See
+Description: Interface to 'DistillerSR' APIs. See
   <https://apidocs.evidencepartners.com/> for more details.
 License: EUPL-1.2
 URL: https://openefsa.github.io/distilleR/

R/buildAuthenticationRequest.R

@@ -26,14 +26,6 @@
 #' 
 #' @importFrom checkmate assert_string assert_int
 #' @importFrom httr2 request req_method req_headers req_timeout
-#'
-#' @examplesIf FALSE
-#' distillerInstanceUrl_ <- "https://url.to.distiller.instance"
-#' distillerKey_ <- "YOUR_API_KEY"
-#' 
-#' request_ <- .buildAuthenticationRequest(
-#'   distillerInstanceUrl = distillerInstanceUrl_,
-#'   distillerKey = distillerKey_)
 #' 
 #' @keywords internal
 #' @noRd

R/buildServiceRequest.R

@@ -30,15 +30,6 @@
 #' 
 #' @importFrom checkmate assert_string assert_list assert_int
 #' @importFrom httr2 request req_method req_headers req_timeout req_body_json
-#'
-#' @examplesIf FALSE
-#' serviceUrl_ <- "https://url.to.distiller.instance/projects"
-#' 
-#' distillerToken_ <- getAuthenticationToken()
-#' 
-#' serviceRequest_ <- .buildServiceRequest(
-#'   serviceUrl = serviceUrl_,
-#'   distillerToken = distillerToken_)
 #' 
 #' @keywords internal
 #' @noRd

R/getAuthenticationToken.R

@@ -26,16 +26,17 @@
 #'
 #' @importFrom checkmate assert_string assert_int
 #'
-#' @examplesIf FALSE
+#' @examples
+#' \dontrun{
 #' # If 'DISTILLER_INSTANCE_URL' and 'DISTILLER_API_KEY' are defined in your
 #' # environment (e.g. .Renviron).
 #' distillerToken_ <- getAuthenticationToken()
 #' 
 #' # If 'distillerInstanceUrl' and 'distillerKey' are to be specified manually.
 #' distillerToken_ <- getAuthenticationToken(
 #'   distillerInstanceUrl = "https://url.to.distiller.instance",
-#'   distillerKey = "YOUR_API_KEY"
-#' )
+#'   distillerKey = "YOUR_API_KEY")
+#' }
 #' 
 #' @export
 #' 

R/getProjects.R

@@ -30,10 +30,12 @@
 #'
 #' @seealso \code{\link{getAuthenticationToken}}
 #'
-#' @examplesIf FALSE
+#' @examples
+#' \dontrun{
 #' distillerToken_ <- getAuthenticationToken()
 #' 
 #' projects_ <- getProjects(distillerToken = distillerToken_)
+#' }
 #' 
 #' @export
 #' 

R/getReport.R

@@ -47,9 +47,12 @@
 #' @seealso \code{\link{getProjects}}
 #' @seealso \code{\link{getReports}}
 #'
-#' @examplesIf FALSE
+#' @examples
+#' \dontrun{
 #' distillerToken_ <- getAuthenticationToken()
+#' 
 #' projects_ <- getProjects(distillerToken = distillerToken_)
+#' 
 #' reports_ <- getReports(
 #'   projectId = projects_$id[1],
 #'   distillerToken = distillerToken_)
@@ -59,6 +62,7 @@
 #'   reportID = reports_$id[7],
 #'   format = "csv",
 #'   distillerToken = distillerToken_)
+#' }
 #' 
 #' @export
 #' 

R/getReports.R

@@ -34,13 +34,16 @@
 #' @seealso \code{\link{getAuthenticationToken}}
 #' @seealso \code{\link{getProjects}}
 #' 
-#' @examplesIf FALSE
+#' @examples
+#' \dontrun{
 #' distillerToken_ <- getAuthenticationToken()
+#' 
 #' projects_ <- getProjects(distillerToken = distillerToken_)
 #' 
 #' reports_ <- getReports(
 #'   projectId = projects_$id[1],
 #'   distillerToken = distillerToken_)
+#' }
 #' 
 #' @export
 #' 

R/handleHTTPErrors.R

@@ -15,11 +15,6 @@
 #' @importFrom checkmate assert_class assert_string
 #' @importFrom httr2 resp_status
 #' @importFrom cli cli_abort
-#'
-#' @examplesIf FALSE
-#' response_ <- req_perform(request("https://example.org/"))
-#' 
-#' .handleHTTPErrors(response = response_)
 #' 
 #' @keywords internal
 #' @noRd

R/parseCSVResponse.R

@@ -23,11 +23,6 @@
 #' @importFrom readr read_csv cols
 #' @importFrom httr2 resp_body_string
 #' @importFrom cli cli_abort
-#'
-#' @examplesIf FALSE
-#' response_ <- req_perform(request("https://example.org/"))
-#' 
-#' csvResponseData_ <- .parseCSVResponse(response = response_)
 #' 
 #' @keywords internal
 #' @noRd

R/parseJSONResponse.R

@@ -18,11 +18,6 @@
 #' @importFrom jsonlite fromJSON
 #' @importFrom httr2 resp_body_string
 #' @importFrom cli cli_abort
-#'
-#' @examplesIf FALSE
-#' response_ <- req_perform(request("https://example.org/"))
-#' 
-#' responseData_ <- .parseJSONResponse(response = response_)
 #' 
 #' @keywords internal
 #' @noRd

R/parseXLSXResponse.R

@@ -18,11 +18,6 @@
 #' @importFrom readxl read_excel
 #' @importFrom httr2 resp_body_raw
 #' @importFrom cli cli_abort
-#'
-#' @examplesIf FALSE
-#' response_ <- req_perform(request("https://example.org/"))
-#' 
-#' xlsxResponseData_ <- .parseXLSXResponse(response = response_)
 #' 
 #' @keywords internal
 #' @noRd

R/performRequest.R

@@ -17,11 +17,6 @@
 #' @importFrom httr2 req_perform
 #' @importFrom cli cli_abort
 #' 
-#' @examplesIf FALSE
-#' request_ <- request("https://example.org/")
-#' 
-#' response_ <- .performRequest(request = request_)
-#' 
 #' @keywords internal
 #' @noRd
 #' 

R/sleep.R

@@ -6,10 +6,6 @@
 #' @param seconds `integer`. The maximum number of seconds to wait.
 #' 
 #' @importFrom checkmate assert_int
-#'
-#' @examplesIf FALSE
-#' # Sleep for 1 second.
-#' .sleep(1)
 #' 
 #' @keywords internal
 #' @noRd