Any resource

DESCRIPTION

@@ -23,5 +23,5 @@ Suggests:
 Depends: R (>= 4.1.0)
 Encoding: UTF-8
 VignetteBuilder: knitr
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1
 LazyData: true

NEWS.md

@@ -1,6 +1,13 @@
+# dhis2r 0.2.0
+
+## Improvements 
+
+* Add authentication via personal access token @Brar
+
+* Added   `get_any_analytic()` to cater for long DHIS2 favorites 
+
 # dhis2r 0.1.1
-Updated tests for analytics to be flexible to cover unavailable data on a DHIS2 instance
 
-# dhis2r 0.1.0
+* Fix R CMD check failures on CRAN
 
-* Added a `NEWS.md` file to track changes to the package.
+* Added a NEWS.md file to track changes to the package.

R/connect.R

@@ -112,7 +112,7 @@
       }
 
       self$request_sent <-  self$request_sent |>
-        req_url_query(paging = "false") |>
+      #  req_url_query(paging = "false") |>
         req_headers("Accept" = "application/json") |>
         httr2::req_user_agent("dhis2r (http://www.amanyiraho.com/dhis2r/") |>
         httr2::req_retry(max_tries = 5)
@@ -233,7 +233,7 @@
     #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     #' @description Get all possible analytics resources from a DHIS2 instance i.e
     #'
-    #' @return A vector of all possible fields for a specific metadata
+    #' @return A data frame of the analytics resource
     #'
     #' @param analytic  vector of ID of specific analytic(s) from a DHIS2 instance
     #' @param org_unit  vector of ID of specific organisation unit(s) from a DHIS2 instance
@@ -284,7 +284,50 @@
 
 
 
-               }
+               },
+
+    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    #' @description Get all any analytics resource from a DHIS2 instance to cater for long DHIS2 favorites
+    #'
+    #' @return A data frame of the analytics resource
+    #'
+    #' @param endpoint_url   string part of Analytic(s) from a DHIS2 instance api endpoint starting from `analytics.json?dimension=dx%3...`
+    #'
+    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+    get_any_analytic = function(endpoint_url) {
+      # Check for internet
+      check_internet()
+      args <- list(endpoint_url = endpoint_url)
+      #Check that at least one argument is not null
+
+      attempt::stop_if_any(args, is.null,"You need to specify all arguements")
+      attempt::stop_if_none(args, is.character, "All arguements should be type character")
+
+
+      response_object <- self$request_sent |>
+        req_url_path_append(endpoint_url) |>
+        req_perform()
+
+      print(response_object$url)
+
+
+      response_data  <-  response_object |>
+        resp_body_json(simplifyVector = TRUE, flatten = TRUE)
+
+      if(length(response_data$rows) == 0){
+
+        as.data.frame(response_data$rows)
+
+      }else{
+        as.data.frame(response_data$rows) |>
+          tibble::as_tibble()
+      }
+
+
+
+    }
+
 
 
     )

README.Rmd

@@ -75,7 +75,9 @@ Alternatively you can generate a [personal access token](https://docs.dhis2.org/
 
 ``` r
 library(dhis2r)
+
 # Replace the value of api_token with the token you have generated
+
 dhis2_play_connection <- Dhis2r$new(base_url = "https://play.dhis2.org/",
                                     api_token = "d2pat_5xVA12xyUbWNedQxy4ohH77WlxRGVvZZ1151814092")
 ```

README.md

@@ -73,6 +73,19 @@ dhis2_play_connection <- Dhis2r$new(base_url = "https://play.dhis2.org/",
                                     api_version_position = "before")
 ```
 
+Alternatively you can generate a [personal access
+token](https://docs.dhis2.org/en/develop/using-the-api/dhis-core-version-master/introduction.html#webapi_pat_authentication)
+and use that to connect.
+
+``` r
+library(dhis2r)
+
+# Replace the value of api_token with the token you have generated
+
+dhis2_play_connection <- Dhis2r$new(base_url = "https://play.dhis2.org/",
+                                    api_token = "d2pat_5xVA12xyUbWNedQxy4ohH77WlxRGVvZZ1151814092")
+```
+
 `Dhis2r$new()` returns a `Dhis2r` R6 class which represents a DHIS2
 connection and can be used to query the DHIS2 instance