diff --git a/search.json b/search.json
index 9a0d695..0159595 100644
--- a/search.json
+++ b/search.json
@@ -1 +1 @@
-[{"path":[]},{"path":"http://www.amanyiraho.com/dhis2r/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"http://www.amanyiraho.com/dhis2r/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"http://www.amanyiraho.com/dhis2r/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"http://www.amanyiraho.com/dhis2r/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"http://www.amanyiraho.com/dhis2r/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement amanyiraho@gmail.com. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"http://www.amanyiraho.com/dhis2r/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"http://www.amanyiraho.com/dhis2r/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"http://www.amanyiraho.com/dhis2r/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"http://www.amanyiraho.com/dhis2r/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"http://www.amanyiraho.com/dhis2r/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"http://www.amanyiraho.com/dhis2r/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired [Mozilla’s code conduct enforcement ladder][https://github.com/mozilla/inclusion]. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"http://www.amanyiraho.com/dhis2r/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2023 dhis2r authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"http://www.amanyiraho.com/dhis2r/articles/dhis2r.html","id":"get-user-information","dir":"Articles","previous_headings":"","what":"Get user information","title":"Getting started with dhis2r","text":"Get information account Get access rights information account","code":"# [Ways of keeping your user credentials safe](https://solutions.posit.co/connections/db/best-practices/managing-credentials/) dhis2_play_connection$get_user_info() #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/me\" #> name email #> \"John Traore\" \"dummy@dhis2.org\" dhis2_play_connection$account_info #> created #> \"2013-04-18T17:15:08.407\" dhis2_play_connection$access_rights #> manage externalize write read update delete #> TRUE FALSE TRUE TRUE TRUE TRUE"},{"path":"http://www.amanyiraho.com/dhis2r/articles/dhis2r.html","id":"get-metadata","dir":"Articles","previous_headings":"","what":"Get metadata","title":"Getting started with dhis2r","text":"Get resources can get metadata . Get metadata Data Elements using plural name dataElements. code returns ’s name code/ID used DHIS2, shall use code get analytics.","code":"dhis2_play_connection$get_metadata() #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/resources\" #> # A tibble: 89 × 4 #> displayName singular plural href #> #> 1 Indicator Groups indicatorGroup indic… http… #> 2 Organisation Unit Group Sets organisationUnitGroupSet organ… http… #> 3 Validation Notification Templates validationNotificationTemplate valid… http… #> 4 Legend Sets legendSet legen… http… #> 5 Categories category categ… http… #> 6 Program Data Elements programDataElement progr… http… #> 7 Tracked Entity Types trackedEntityType track… http… #> 8 External File Resources externalFileResource exter… http… #> 9 Program Indicator Groups programIndicatorGroup progr… http… #> 10 Event Reports eventReport event… http… #> # ℹ 79 more rows dhis2_play_connection$get_metadata(endpoint = \"dataElements\") #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/dataElements?fields=name%2Cid\" #> # A tibble: 5 × 1 #> `response_data[[1]]` #> #> 1 #> 2 #> 3 #> 4 #> 5 "},{"path":"http://www.amanyiraho.com/dhis2r/articles/dhis2r.html","id":"get-all-possible-fields-of-a-metadata-of-a-resource","dir":"Articles","previous_headings":"Get metadata","what":"Get all possible fields of a metadata of a resource","title":"Getting started with dhis2r","text":"can get fields beyond ID name NOTE resources different fields","code":"dhis2_play_connection$get_metadata_fields(endpoint = \"dataElements\") #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/dataElements?fields=%3Aall&paging=true&pageSize=1\" #> [1] \"access\" \"aggregationLevels\" \"aggregationType\" #> [4] \"attributeValues\" \"categoryCombo\" \"code\" #> [7] \"created\" \"createdBy\" \"dataElementGroups\" #> [10] \"dataSetElements\" \"dimensionItem\" \"dimensionItemType\" #> [13] \"displayFormName\" \"displayName\" \"displayShortName\" #> [16] \"domainType\" \"externalAccess\" \"favorite\" #> [19] \"favorites\" \"href\" \"id\" #> [22] \"lastUpdated\" \"legendSets\" \"name\" #> [25] \"optionSetValue\" \"publicAccess\" \"sharing\" #> [28] \"shortName\" \"translations\" \"url\" #> [31] \"user\" \"userAccesses\" \"userGroupAccesses\" #> [34] \"valueType\" \"zeroIsSignificant\" dhis2_play_connection$get_metadata_fields(endpoint = \"organisationUnits\") #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/organisationUnits?fields=%3Aall&paging=true&pageSize=1\" #> [1] \"access\" \"ancestors\" \"attributeValues\" #> [4] \"children\" \"code\" \"created\" #> [7] \"dataSets\" \"dimensionItem\" \"dimensionItemType\" #> [10] \"displayFormName\" \"displayName\" \"displayShortName\" #> [13] \"externalAccess\" \"favorite\" \"favorites\" #> [16] \"href\" \"id\" \"lastUpdated\" #> [19] \"leaf\" \"legendSets\" \"level\" #> [22] \"name\" \"openingDate\" \"organisationUnitGroups\" #> [25] \"parent\" \"path\" \"programs\" #> [28] \"sharing\" \"shortName\" \"translations\" #> [31] \"userAccesses\" \"userGroupAccesses\" \"users\" dhis2_play_connection$get_metadata_fields(endpoint = \"indicators\") #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/indicators?fields=%3Aall&paging=true&pageSize=1\" #> [1] \"access\" \"annualized\" #> [3] \"attributeValues\" \"code\" #> [5] \"created\" \"createdBy\" #> [7] \"dataSets\" \"denominator\" #> [9] \"denominatorDescription\" \"description\" #> [11] \"dimensionItem\" \"dimensionItemType\" #> [13] \"displayDenominatorDescription\" \"displayDescription\" #> [15] \"displayFormName\" \"displayName\" #> [17] \"displayNumeratorDescription\" \"displayShortName\" #> [19] \"externalAccess\" \"favorite\" #> [21] \"favorites\" \"href\" #> [23] \"id\" \"indicatorGroups\" #> [25] \"indicatorType\" \"lastUpdated\" #> [27] \"legendSets\" \"name\" #> [29] \"numerator\" \"numeratorDescription\" #> [31] \"publicAccess\" \"sharing\" #> [33] \"shortName\" \"translations\" #> [35] \"url\" \"user\" #> [37] \"userAccesses\" \"userGroupAccesses\""},{"path":"http://www.amanyiraho.com/dhis2r/articles/dhis2r.html","id":"getting-metadata-fields-beyond-id-and-name","dir":"Articles","previous_headings":"","what":"Getting metadata fields beyond ID and Name","title":"Getting started with dhis2r","text":"dataElements organisationUnits can use \":\" fields get fields metadata associated resources periodTypes","code":"dhis2_play_connection$get_metadata(endpoint = \"dataElements\", fields = c(\"name\",\"id\",\"aggregationType\")) #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/dataElements?fields=name%2Cid%2CaggregationType\" #> # A tibble: 5 × 1 #> `response_data[[1]]` #> #> 1 #> 2 #> 3 #> 4 #> 5 dhis2_play_connection$get_metadata(endpoint = \"organisationUnits\", fields = c(\"name\",\"id\", \"level\")) #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/organisationUnits?fields=name%2Cid%2Clevel\" #> # A tibble: 5 × 1 #> `response_data[[1]]` #> #> 1 #> 2 #> 3 #> 4 #> 5 dhis2_play_connection$get_metadata(endpoint = \"periodTypes\", fields = \":all\") #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/periodTypes?fields=%3Aall\" #> # A tibble: 19 × 4 #> name isoDuration isoFormat frequencyOrder #> #> 1 Daily P1D yyyyMMdd 1 #> 2 Weekly P7D yyyyWn 7 #> 3 WeeklyWednesday P7D yyyyWedWn 7 #> 4 WeeklyThursday P7D yyyyThuWn 7 #> 5 WeeklySaturday P7D yyyySatWn 7 #> 6 WeeklySunday P7D yyyySunWn 7 #> 7 BiWeekly P14D yyyyBiWn 14 #> 8 Monthly P1M yyyyMM 30 #> 9 BiMonthly P2M yyyyMMB 61 #> 10 Quarterly P3M yyyyQn 91 #> 11 QuarterlyNov P3M yyyyNovQn 91 #> 12 SixMonthly P6M yyyySn 182 #> 13 SixMonthlyApril P6M yyyyAprilSn 182 #> 14 SixMonthlyNov P6M yyyyNovSn 182 #> 15 Yearly P1Y yyyy 365 #> 16 FinancialApril P1Y yyyyApril 365 #> 17 FinancialJuly P1Y yyyyJuly 365 #> 18 FinancialOct P1Y yyyyOct 365 #> 19 FinancialNov P1Y yyyyNov 365"},{"path":"http://www.amanyiraho.com/dhis2r/articles/dhis2r.html","id":"indicators","dir":"Articles","previous_headings":"","what":"indicators","title":"Getting started with dhis2r","text":"","code":"dhis2_play_connection$get_metadata(endpoint = \"indicators\") #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/indicators?fields=name%2Cid\" #> # A tibble: 5 × 1 #> `response_data[[1]]` #> #> 1 #> 2 #> 3 #> 4 #> 5 "},{"path":"http://www.amanyiraho.com/dhis2r/articles/dhis2r.html","id":"get-analtyics","dir":"Articles","previous_headings":"","what":"Get analtyics","title":"Getting started with dhis2r","text":"","code":"# dhis2_play_connection$get_analytics(analytic = \"s46m5MS0hxu\", # org_unit = c(\"O6uvpzGd5pu\", \"fdc6uOvgoji\"), # period = \"202101\", # output_scheme = \"NAME\") # dhis2_play_connection$get_analytics(analytic = \"FTRrcoaog83\", #Accute Flaccid Paralysis (Deaths < 5 yrs) # org_unit = c(\"ImspTQPwCqd\"), #Sierra Leone (National level) # period = \"LAST_12_MONTHS\", # output_scheme = \"NAME\")"},{"path":"http://www.amanyiraho.com/dhis2r/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Robinson Amanyiraho. Maintainer, author, copyright holder.","code":""},{"path":"http://www.amanyiraho.com/dhis2r/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Amanyiraho R (2024). dhis2r: Client 'DHIS2' Web API. R package version 0.2.1, https://github.com/amanyiraho/dhis2r.","code":"@Manual{, title = {dhis2r: Client for the 'DHIS2' Web API}, author = {Robinson Amanyiraho}, year = {2024}, note = {R package version 0.2.1}, url = {https://github.com/amanyiraho/dhis2r}, }"},{"path":[]},{"path":"http://www.amanyiraho.com/dhis2r/index.html","id":"overview","dir":"","previous_headings":"","what":"Overview","title":"Client for the DHIS2 Web API","text":"dhis2r R client DHIS2 web API. Pull data DHIS2 instance R without logging DHIS2 user interface. dhis2r, used Rmarkdown, quarto, Rshiny, etc., can improve routine reporting data requests.","code":""},{"path":"http://www.amanyiraho.com/dhis2r/index.html","id":"motivation-for-this-package","dir":"","previous_headings":"Overview","what":"Motivation for this package","title":"Client for the DHIS2 Web API","text":"DHIS2 open-source, web-based Health Management Information System (HMIS), currently adopted education sector Education Management Information System (EMIS) several countries. 73 countries worldwide use DHIS2 collecting analyzing health data. 2.4 billion people (30% world’s population) live countries DHIS2 used. (source: https://dhis2.org/) increasing number data managers/analysts downloading data DHIS2 instances make routine period reports, data visualisation dashboards, R package can make much easier pull required data. 2 million R users, periodically analyse data DHIS2; support health programs affect 2.4 billion people.","code":""},{"path":"http://www.amanyiraho.com/dhis2r/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Client for the DHIS2 Web API","text":"can install stable version dhis2r CRAN : can install also development version dhis2r GitHub :","code":"install.packages(\"dhis2r\") # install.packages(\"devtools\") devtools::install_github(\"amanyiraho/dhis2r\")"},{"path":[]},{"path":"http://www.amanyiraho.com/dhis2r/index.html","id":"how-to-connect-to-a-dhis2","dir":"","previous_headings":"Usage","what":"How to connect to a DHIS2?","title":"Client for the DHIS2 Web API","text":"Users must authenticated access specific DHIS2 instance connecting . can use username password Personal Access Token (PAT)","code":""},{"path":"http://www.amanyiraho.com/dhis2r/index.html","id":"id_1-using-username-and-password","dir":"","previous_headings":"Usage > How to connect to a DHIS2?","what":"1. Using username and password","title":"Client for the DHIS2 Web API","text":"easiest way connect DHIS2 instance using dhis2r use username password DHIS2 user.","code":"library(dhis2r) dhis2_play_connection <- Dhis2r$new(base_url = \"https://play.im.dhis2.org/stable-2-40-5\", username = \"admin\", password = \"district\")"},{"path":"http://www.amanyiraho.com/dhis2r/index.html","id":"id_2-using-personal-access-token-pat","dir":"","previous_headings":"Usage > How to connect to a DHIS2?","what":"2. Using Personal Access Token (PAT)","title":"Client for the DHIS2 Web API","text":"Alternatively can generate personal access token use connect. Dhis2r$new() returns Dhis2r R6 class represents DHIS2 connection can used query DHIS2 instance need log performing querying tasks.","code":"library(dhis2r) # Replace the value of api_token with the token you have generated dhis2_play_connection <- Dhis2r$new(base_url = \"https://play.im.dhis2.org/stable-2-40-5\", api_token = \"d2pat_2EkxmqdxtwAGDGe1hXzpWEixYdvHGRw71587176066\")"},{"path":"http://www.amanyiraho.com/dhis2r/index.html","id":"how-to-pull-data-from-dhis2","dir":"","previous_headings":"Usage","what":"How to pull data from DHIS2","title":"Client for the DHIS2 Web API","text":"example, let’s pull Analytics data BCG doses given Analytics data can include data indicators, dataElements, program indicators, etc. can pull data following: Information account Access rights information account Metadata Organisation units Analytics possible resources depth illustration use vignette dhis2r vignette(\"dhis2r\") Please note dhis2r project released Contributor Code Conduct. contributing project, agree abide terms.","code":"dhis2_play_connection$get_analytics(analytic = \"s46m5MS0hxu\", #BCG doses given org_unit = \"ImspTQPwCqd\", #Sierra Leone (National level) period = \"202101\", output_scheme = \"NAME\" )"},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":null,"dir":"Reference","previous_headings":"","what":"Connect and pull/get data from a DHIS2 instance — Dhis2r","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"create DHIS2 connection, need DHIS2 base URL, username, password, API version R6 Class called `Dhis2r` representing DHIS2 instance connection","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"R6 class called Dhis2r.","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"can use DHIS2 instance connection get data several times without needing manually supply user credentials API call.","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"request_sent request used perform API call name Name user access_rights access rights user DHIS2 instance account_info Information logged account credentials","code":""},{"path":[]},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"Dhis2r$new() Dhis2r$get_user_info() Dhis2r$get_metadata() Dhis2r$get_metadata_fields() Dhis2r$get_analytics() Dhis2r$get_any_analytic() Dhis2r$clone()","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"Create connection DHIS2 instance using basic authentication","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"","code":"Dhis2r$new( base_url, username = NULL, password = NULL, api_token = NULL, api_version = NULL, api_version_position = c(\"after\", \"before\") )"},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"base_url Base url e.g https://play.dhis2.org/ username Registered username e.g \"admin\" password Registered password e.g \"district\" api_token Personal Access Token (PAT) use instead username password api_version api version e.g \"33\" api_version_position position api_version web API url .e /api/","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"new `Dhis2r` object","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"method-get-user-info-","dir":"Reference","previous_headings":"","what":"Method get_user_info()","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"Get information logged user","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"","code":"Dhis2r$get_user_info()"},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"vector","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"method-get-metadata-","dir":"Reference","previous_headings":"","what":"Method get_metadata()","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"Get metadata available resource DHIS2 instance e.g \"dataElements\", \"organisationUnits\", \"indicators\", \"periodTypes\"","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"","code":"Dhis2r$get_metadata(endpoint = NULL, fields = c(\"name\", \"id\"))"},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"endpoint resource, get available resources using `get_metadata()` without arguments fields specific columns return dataframe e.g c(\"name\",\"id\")","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"returns-2","dir":"Reference","previous_headings":"","what":"Returns","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"data frame","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"method-get-metadata-fields-","dir":"Reference","previous_headings":"","what":"Method get_metadata_fields()","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"Get possible fields specific metadata resource DHIS2 instance","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"","code":"Dhis2r$get_metadata_fields(endpoint)"},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"endpoint resource, get available resources using `get_metadata()` without arguments","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"returns-3","dir":"Reference","previous_headings":"","what":"Returns","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"vector possible fields specific metadata","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"method-get-analytics-","dir":"Reference","previous_headings":"","what":"Method get_analytics()","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"Get possible analytics resources DHIS2 instance .e","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"","code":"Dhis2r$get_analytics( analytic, org_unit, period, output_scheme = c(\"UID\", \"NAME\") )"},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"analytic vector ID specific analytic(s) DHIS2 instance org_unit vector ID specific organisation unit(s) DHIS2 instance period vector relative fixed periods DHIS2 instance output_scheme Output type ID Names fields","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"returns-4","dir":"Reference","previous_headings":"","what":"Returns","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"data frame analytics resource","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"method-get-any-analytic-","dir":"Reference","previous_headings":"","what":"Method get_any_analytic()","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"Get analytics resource DHIS2 instance cater long DHIS2 favorites","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"","code":"Dhis2r$get_any_analytic(endpoint_url)"},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"endpoint_url string part Analytic(s) DHIS2 instance api endpoint starting 'analytics.json?dimension='","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"returns-5","dir":"Reference","previous_headings":"","what":"Returns","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"data frame analytics resource","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"objects class cloneable method.","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"","code":"Dhis2r$clone(deep = FALSE)"},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"arguments-5","dir":"Reference","previous_headings":"","what":"Arguments","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"deep Whether make deep clone.","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"","code":"# Load dhis2r library(dhis2r) # connect to the DHIS2 instance dhis2_play_connection <- Dhis2r$new(base_url = \"https://play.im.dhis2.org/stable-2-40-5\", username = \"admin\", password = \"district\") # get all the available resources dhis2_play_connection$get_metadata() #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/resources\" #> # A tibble: 89 × 4 #> displayName singular plural href #> #> 1 Indicator Groups indicatorGroup indic… http… #> 2 Organisation Unit Group Sets organisationUnitGroupSet organ… http… #> 3 Validation Notification Templates validationNotificationTemplate valid… http… #> 4 Legend Sets legendSet legen… http… #> 5 Categories category categ… http… #> 6 Program Data Elements programDataElement progr… http… #> 7 Tracked Entity Types trackedEntityType track… http… #> 8 External File Resources externalFileResource exter… http… #> 9 Program Indicator Groups programIndicatorGroup progr… http… #> 10 Event Reports eventReport event… http… #> # ℹ 79 more rows # get organisation Units with the default fields i.e c(\"name\",\"id\") dhis2_play_connection$get_metadata(endpoint = \"organisationUnits\") #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/organisationUnits?fields=name%2Cid\" #> # A tibble: 5 × 1 #> `response_data[[1]]` #> #> 1 #> 2 #> 3 #> 4 #> 5 # get a vector of all possible fields of a organisation unit resource dhis2_play_connection$get_metadata_fields(endpoint = \"organisationUnits\") #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/organisationUnits?fields=%3Aall&paging=true&pageSize=1\" #> [1] \"access\" \"ancestors\" \"attributeValues\" #> [4] \"children\" \"code\" \"created\" #> [7] \"dataSets\" \"dimensionItem\" \"dimensionItemType\" #> [10] \"displayFormName\" \"displayName\" \"displayShortName\" #> [13] \"externalAccess\" \"favorite\" \"favorites\" #> [16] \"href\" \"id\" \"lastUpdated\" #> [19] \"leaf\" \"legendSets\" \"level\" #> [22] \"name\" \"openingDate\" \"organisationUnitGroups\" #> [25] \"parent\" \"path\" \"programs\" #> [28] \"sharing\" \"shortName\" \"translations\" #> [31] \"userAccesses\" \"userGroupAccesses\" \"users\" # get organisation Units with additional fields i.e c(\"name\",\"id\", \"level\") dhis2_play_connection$get_metadata(endpoint = \"organisationUnits\", fields = c(\"name\",\"id\", \"level\")) #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/organisationUnits?fields=name%2Cid%2Clevel\" #> # A tibble: 5 × 1 #> `response_data[[1]]` #> #> 1 #> 2 #> 3 #> 4 #> 5 dhis2_play_connection$get_analytics(analytic = c(\"Uvn6LCg7dVU\"), org_unit = c(\"O6uvpzGd5pu\", \"fdc6uOvgoji\"), period = \"LAST_12_MONTHS\", output_scheme = \"NAME\") #> Error in req_perform(req_url_query(req_url_query(req_url_path_append(self$request_sent, \"analytics\"), dimension = I(paste(analytic, org_unit, period, sep = \"&\"))), outputIdScheme = output_scheme)): HTTP 409 Conflict."},{"path":"http://www.amanyiraho.com/dhis2r/reference/dhis2r-package.html","id":null,"dir":"Reference","previous_headings":"","what":"dhis2r: Client for the 'DHIS2' Web API — dhis2r-package","title":"dhis2r: Client for the 'DHIS2' Web API — dhis2r-package","text":"Connect pull data 'DHIS2 (District Health Information Software 2)' instance R.","code":""},{"path":[]},{"path":"http://www.amanyiraho.com/dhis2r/reference/dhis2r-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"dhis2r: Client for the 'DHIS2' Web API — dhis2r-package","text":"Maintainer: Robinson Amanyiraho amanyiraho@gmail.com (ORCID) [copyright holder]","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/relative_periods.html","id":null,"dir":"Reference","previous_headings":"","what":"Relative periods in DHIS2 — relative_periods","title":"Relative periods in DHIS2 — relative_periods","text":"relative periods relative current date allow e.g. creating dynamic reports","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/relative_periods.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Relative periods in DHIS2 — relative_periods","text":"","code":"data(relative_periods)"},{"path":"http://www.amanyiraho.com/dhis2r/reference/relative_periods.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"Relative periods in DHIS2 — relative_periods","text":"data frame 30 rows 2 columns: period_type Period type period Relative period used","code":""},{"path":"http://www.amanyiraho.com/dhis2r/reference/relative_periods.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"Relative periods in DHIS2 — relative_periods","text":"\"https://docs.dhis2.org/en/develop/using--api/dhis-core-version-239/introduction.html\"","code":""},{"path":"http://www.amanyiraho.com/dhis2r/news/index.html","id":"dhis2r-021","dir":"Changelog","previous_headings":"","what":"dhis2r 0.2.1","title":"dhis2r 0.2.1","text":"CRAN release: 2024-11-04","code":""},{"path":"http://www.amanyiraho.com/dhis2r/news/index.html","id":"bug-fix-0-2-1","dir":"Changelog","previous_headings":"","what":"Bug fix","title":"dhis2r 0.2.1","text":"Updated vignette use username password instead PAT since public server regularly updated","code":""},{"path":"http://www.amanyiraho.com/dhis2r/news/index.html","id":"dhis2r-020","dir":"Changelog","previous_headings":"","what":"dhis2r 0.2.0","title":"dhis2r 0.2.0","text":"CRAN release: 2024-10-29","code":""},{"path":"http://www.amanyiraho.com/dhis2r/news/index.html","id":"new-features-0-2-0","dir":"Changelog","previous_headings":"","what":"New features","title":"dhis2r 0.2.0","text":"Dhis2r$new() now includes api_token = NULL authentication via personal access token option(@Brar, #12). New dhis2_connection$get_any_analytic() GET long DHIS2 resources. Functions now print resource link queried","code":""},{"path":"http://www.amanyiraho.com/dhis2r/news/index.html","id":"minor-improvements-and-fixes-0-2-0","dir":"Changelog","previous_headings":"","what":"Minor improvements and fixes","title":"dhis2r 0.2.0","text":"Updated public server URL examples vignettes “https://play.im.dhis2.org/stable-2-40-5”","code":""},{"path":"http://www.amanyiraho.com/dhis2r/news/index.html","id":"dhis2r-011","dir":"Changelog","previous_headings":"","what":"dhis2r 0.1.1","title":"dhis2r 0.1.1","text":"CRAN release: 2023-02-15 Fix R CMD check failures CRAN. Added NEWS.md file track changes package.","code":""}]
+[{"path":[]},{"path":"https://dhis2r.amanyiraho.com/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://dhis2r.amanyiraho.com/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://dhis2r.amanyiraho.com/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://dhis2r.amanyiraho.com/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://dhis2r.amanyiraho.com/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement amanyiraho@gmail.com. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://dhis2r.amanyiraho.com/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://dhis2r.amanyiraho.com/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://dhis2r.amanyiraho.com/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://dhis2r.amanyiraho.com/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://dhis2r.amanyiraho.com/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://dhis2r.amanyiraho.com/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired [Mozilla’s code conduct enforcement ladder][https://github.com/mozilla/inclusion]. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://dhis2r.amanyiraho.com/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2023 dhis2r authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://dhis2r.amanyiraho.com/articles/dhis2r.html","id":"get-user-information","dir":"Articles","previous_headings":"","what":"Get user information","title":"Getting started with dhis2r","text":"Get information account Get access rights information account","code":"# [Ways of keeping your user credentials safe](https://solutions.posit.co/connections/db/best-practices/managing-credentials/) dhis2_play_connection$get_user_info() #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/me\" #> name email #> \"John Traore\" \"dummy@dhis2.org\" dhis2_play_connection$account_info #> created #> \"2013-04-18T17:15:08.407\" dhis2_play_connection$access_rights #> manage externalize write read update delete #> TRUE FALSE TRUE TRUE TRUE TRUE"},{"path":"https://dhis2r.amanyiraho.com/articles/dhis2r.html","id":"get-metadata","dir":"Articles","previous_headings":"","what":"Get metadata","title":"Getting started with dhis2r","text":"Get resources can get metadata . Get metadata Data Elements using plural name dataElements. code returns ’s name code/ID used DHIS2, shall use code get analytics.","code":"dhis2_play_connection$get_metadata() #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/resources\" #> # A tibble: 89 × 4 #> displayName singular plural href #> #> 1 Indicator Groups indicatorGroup indic… http… #> 2 Organisation Unit Group Sets organisationUnitGroupSet organ… http… #> 3 Sms Commands smsCommand smsCo… http… #> 4 Program Rules programRule progr… http… #> 5 Category Combos categoryCombo categ… http… #> 6 Validation Notification Templates validationNotificationTemplate valid… http… #> 7 User Roles userRole userR… http… #> 8 Organisation Unit Levels organisationUnitLevel organ… http… #> 9 Program Sections programSection progr… http… #> 10 Option Groups optionGroup optio… http… #> # ℹ 79 more rows dhis2_play_connection$get_metadata(endpoint = \"dataElements\") #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/dataElements?fields=name%2Cid\" #> # A tibble: 5 × 1 #> `response_data[[1]]` #> #> 1 #> 2 #> 3 #> 4 #> 5 "},{"path":"https://dhis2r.amanyiraho.com/articles/dhis2r.html","id":"get-all-possible-fields-of-a-metadata-of-a-resource","dir":"Articles","previous_headings":"Get metadata","what":"Get all possible fields of a metadata of a resource","title":"Getting started with dhis2r","text":"can get fields beyond ID name NOTE resources different fields","code":"dhis2_play_connection$get_metadata_fields(endpoint = \"dataElements\") #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/dataElements?fields=%3Aall&paging=true&pageSize=1\" #> [1] \"access\" \"aggregationLevels\" \"aggregationType\" #> [4] \"attributeValues\" \"categoryCombo\" \"code\" #> [7] \"created\" \"createdBy\" \"dataElementGroups\" #> [10] \"dataSetElements\" \"dimensionItem\" \"dimensionItemType\" #> [13] \"displayFormName\" \"displayName\" \"displayShortName\" #> [16] \"domainType\" \"externalAccess\" \"favorite\" #> [19] \"favorites\" \"href\" \"id\" #> [22] \"lastUpdated\" \"legendSets\" \"name\" #> [25] \"optionSetValue\" \"publicAccess\" \"sharing\" #> [28] \"shortName\" \"translations\" \"url\" #> [31] \"user\" \"userAccesses\" \"userGroupAccesses\" #> [34] \"valueType\" \"zeroIsSignificant\" dhis2_play_connection$get_metadata_fields(endpoint = \"organisationUnits\") #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/organisationUnits?fields=%3Aall&paging=true&pageSize=1\" #> [1] \"access\" \"ancestors\" \"attributeValues\" #> [4] \"children\" \"code\" \"created\" #> [7] \"dataSets\" \"dimensionItem\" \"dimensionItemType\" #> [10] \"displayFormName\" \"displayName\" \"displayShortName\" #> [13] \"externalAccess\" \"favorite\" \"favorites\" #> [16] \"href\" \"id\" \"lastUpdated\" #> [19] \"leaf\" \"legendSets\" \"level\" #> [22] \"name\" \"openingDate\" \"organisationUnitGroups\" #> [25] \"parent\" \"path\" \"programs\" #> [28] \"sharing\" \"shortName\" \"translations\" #> [31] \"userAccesses\" \"userGroupAccesses\" \"users\" dhis2_play_connection$get_metadata_fields(endpoint = \"indicators\") #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/indicators?fields=%3Aall&paging=true&pageSize=1\" #> [1] \"access\" \"annualized\" #> [3] \"attributeValues\" \"code\" #> [5] \"created\" \"createdBy\" #> [7] \"dataSets\" \"denominator\" #> [9] \"denominatorDescription\" \"description\" #> [11] \"dimensionItem\" \"dimensionItemType\" #> [13] \"displayDenominatorDescription\" \"displayDescription\" #> [15] \"displayFormName\" \"displayName\" #> [17] \"displayNumeratorDescription\" \"displayShortName\" #> [19] \"externalAccess\" \"favorite\" #> [21] \"favorites\" \"href\" #> [23] \"id\" \"indicatorGroups\" #> [25] \"indicatorType\" \"lastUpdated\" #> [27] \"legendSets\" \"name\" #> [29] \"numerator\" \"numeratorDescription\" #> [31] \"publicAccess\" \"sharing\" #> [33] \"shortName\" \"translations\" #> [35] \"url\" \"user\" #> [37] \"userAccesses\" \"userGroupAccesses\""},{"path":"https://dhis2r.amanyiraho.com/articles/dhis2r.html","id":"getting-metadata-fields-beyond-id-and-name","dir":"Articles","previous_headings":"","what":"Getting metadata fields beyond ID and Name","title":"Getting started with dhis2r","text":"dataElements organisationUnits can use \":\" fields get fields metadata associated resources periodTypes","code":"dhis2_play_connection$get_metadata(endpoint = \"dataElements\", fields = c(\"name\",\"id\",\"aggregationType\")) #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/dataElements?fields=name%2Cid%2CaggregationType\" #> # A tibble: 5 × 1 #> `response_data[[1]]` #> #> 1 #> 2 #> 3 #> 4 #> 5 dhis2_play_connection$get_metadata(endpoint = \"organisationUnits\", fields = c(\"name\",\"id\", \"level\")) #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/organisationUnits?fields=name%2Cid%2Clevel\" #> # A tibble: 5 × 1 #> `response_data[[1]]` #> #> 1 #> 2 #> 3 #> 4 #> 5 dhis2_play_connection$get_metadata(endpoint = \"periodTypes\", fields = \":all\") #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/periodTypes?fields=%3Aall\" #> # A tibble: 19 × 4 #> name isoDuration isoFormat frequencyOrder #> #> 1 Daily P1D yyyyMMdd 1 #> 2 Weekly P7D yyyyWn 7 #> 3 WeeklyWednesday P7D yyyyWedWn 7 #> 4 WeeklyThursday P7D yyyyThuWn 7 #> 5 WeeklySaturday P7D yyyySatWn 7 #> 6 WeeklySunday P7D yyyySunWn 7 #> 7 BiWeekly P14D yyyyBiWn 14 #> 8 Monthly P1M yyyyMM 30 #> 9 BiMonthly P2M yyyyMMB 61 #> 10 Quarterly P3M yyyyQn 91 #> 11 QuarterlyNov P3M yyyyNovQn 91 #> 12 SixMonthly P6M yyyySn 182 #> 13 SixMonthlyApril P6M yyyyAprilSn 182 #> 14 SixMonthlyNov P6M yyyyNovSn 182 #> 15 Yearly P1Y yyyy 365 #> 16 FinancialApril P1Y yyyyApril 365 #> 17 FinancialJuly P1Y yyyyJuly 365 #> 18 FinancialOct P1Y yyyyOct 365 #> 19 FinancialNov P1Y yyyyNov 365"},{"path":"https://dhis2r.amanyiraho.com/articles/dhis2r.html","id":"indicators","dir":"Articles","previous_headings":"","what":"indicators","title":"Getting started with dhis2r","text":"","code":"dhis2_play_connection$get_metadata(endpoint = \"indicators\") #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/indicators?fields=name%2Cid\" #> # A tibble: 5 × 1 #> `response_data[[1]]` #> #> 1 #> 2 #> 3 #> 4 #> 5 "},{"path":"https://dhis2r.amanyiraho.com/articles/dhis2r.html","id":"get-analtyics","dir":"Articles","previous_headings":"","what":"Get analtyics","title":"Getting started with dhis2r","text":"","code":"# dhis2_play_connection$get_analytics(analytic = \"s46m5MS0hxu\", # org_unit = c(\"O6uvpzGd5pu\", \"fdc6uOvgoji\"), # period = \"202101\", # output_scheme = \"NAME\") # dhis2_play_connection$get_analytics(analytic = \"FTRrcoaog83\", #Accute Flaccid Paralysis (Deaths < 5 yrs) # org_unit = c(\"ImspTQPwCqd\"), #Sierra Leone (National level) # period = \"LAST_12_MONTHS\", # output_scheme = \"NAME\")"},{"path":"https://dhis2r.amanyiraho.com/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Robinson Amanyiraho. Maintainer, author, copyright holder.","code":""},{"path":"https://dhis2r.amanyiraho.com/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Amanyiraho R (2024). dhis2r: Client 'DHIS2' Web API. R package version 0.2.1, https://github.com/amanyiraho/dhis2r.","code":"@Manual{, title = {dhis2r: Client for the 'DHIS2' Web API}, author = {Robinson Amanyiraho}, year = {2024}, note = {R package version 0.2.1}, url = {https://github.com/amanyiraho/dhis2r}, }"},{"path":[]},{"path":"https://dhis2r.amanyiraho.com/index.html","id":"overview","dir":"","previous_headings":"","what":"Overview","title":"Client for the DHIS2 Web API","text":"dhis2r R client DHIS2 web API. Pull data DHIS2 instance R without logging DHIS2 user interface. dhis2r, used Rmarkdown, quarto, Rshiny, etc., can improve routine reporting data requests.","code":""},{"path":"https://dhis2r.amanyiraho.com/index.html","id":"motivation-for-this-package","dir":"","previous_headings":"Overview","what":"Motivation for this package","title":"Client for the DHIS2 Web API","text":"DHIS2 open-source, web-based Health Management Information System (HMIS), currently adopted education sector Education Management Information System (EMIS) several countries. 73 countries worldwide use DHIS2 collecting analyzing health data. 2.4 billion people (30% world’s population) live countries DHIS2 used. (source: https://dhis2.org/) increasing number data managers/analysts downloading data DHIS2 instances make routine period reports, data visualisation dashboards, R package can make much easier pull required data. 2 million R users, periodically analyse data DHIS2; support health programs affect 2.4 billion people.","code":""},{"path":"https://dhis2r.amanyiraho.com/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Client for the DHIS2 Web API","text":"can install stable version dhis2r CRAN : can install also development version dhis2r GitHub :","code":"install.packages(\"dhis2r\") # install.packages(\"devtools\") devtools::install_github(\"amanyiraho/dhis2r\")"},{"path":[]},{"path":"https://dhis2r.amanyiraho.com/index.html","id":"how-to-connect-to-a-dhis2","dir":"","previous_headings":"Usage","what":"How to connect to a DHIS2?","title":"Client for the DHIS2 Web API","text":"Users must authenticated access specific DHIS2 instance connecting . can use username password Personal Access Token (PAT)","code":""},{"path":"https://dhis2r.amanyiraho.com/index.html","id":"id_1-using-username-and-password","dir":"","previous_headings":"Usage > How to connect to a DHIS2?","what":"1. Using username and password","title":"Client for the DHIS2 Web API","text":"easiest way connect DHIS2 instance using dhis2r use username password DHIS2 user.","code":"library(dhis2r) dhis2_play_connection <- Dhis2r$new(base_url = \"https://play.im.dhis2.org/stable-2-40-5\", username = \"admin\", password = \"district\")"},{"path":"https://dhis2r.amanyiraho.com/index.html","id":"id_2-using-personal-access-token-pat","dir":"","previous_headings":"Usage > How to connect to a DHIS2?","what":"2. Using Personal Access Token (PAT)","title":"Client for the DHIS2 Web API","text":"Alternatively can generate personal access token use connect. Dhis2r$new() returns Dhis2r R6 class represents DHIS2 connection can used query DHIS2 instance need log performing querying tasks.","code":"library(dhis2r) # Replace the value of api_token with the token you have generated dhis2_play_connection <- Dhis2r$new(base_url = \"https://play.im.dhis2.org/stable-2-40-5\", api_token = \"d2pat_2EkxmqdxtwAGDGe1hXzpWEixYdvHGRw71587176066\")"},{"path":"https://dhis2r.amanyiraho.com/index.html","id":"how-to-pull-data-from-dhis2","dir":"","previous_headings":"Usage","what":"How to pull data from DHIS2","title":"Client for the DHIS2 Web API","text":"example, let’s pull Analytics data BCG doses given Analytics data can include data indicators, dataElements, program indicators, etc. can pull data following: Information account Access rights information account Metadata Organisation units Analytics possible resources depth illustration use vignette dhis2r vignette(\"dhis2r\") Please note dhis2r project released Contributor Code Conduct. contributing project, agree abide terms.","code":"dhis2_play_connection$get_analytics(analytic = \"s46m5MS0hxu\", #BCG doses given org_unit = \"ImspTQPwCqd\", #Sierra Leone (National level) period = \"202101\", output_scheme = \"NAME\" )"},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":null,"dir":"Reference","previous_headings":"","what":"Connect and pull/get data from a DHIS2 instance — Dhis2r","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"create DHIS2 connection, need DHIS2 base URL, username, password, API version R6 Class called `Dhis2r` representing DHIS2 instance connection","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"R6 class called Dhis2r.","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"can use DHIS2 instance connection get data several times without needing manually supply user credentials API call.","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"request_sent request used perform API call name Name user access_rights access rights user DHIS2 instance account_info Information logged account credentials","code":""},{"path":[]},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"Dhis2r$new() Dhis2r$get_user_info() Dhis2r$get_metadata() Dhis2r$get_metadata_fields() Dhis2r$get_analytics() Dhis2r$get_any_analytic() Dhis2r$clone()","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"Create connection DHIS2 instance using basic authentication","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"","code":"Dhis2r$new( base_url, username = NULL, password = NULL, api_token = NULL, api_version = NULL, api_version_position = c(\"after\", \"before\") )"},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"base_url Base url e.g https://play.dhis2.org/ username Registered username e.g \"admin\" password Registered password e.g \"district\" api_token Personal Access Token (PAT) use instead username password api_version api version e.g \"33\" api_version_position position api_version web API url .e /api/","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"new `Dhis2r` object","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"method-get-user-info-","dir":"Reference","previous_headings":"","what":"Method get_user_info()","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"Get information logged user","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"","code":"Dhis2r$get_user_info()"},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"vector","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"method-get-metadata-","dir":"Reference","previous_headings":"","what":"Method get_metadata()","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"Get metadata available resource DHIS2 instance e.g \"dataElements\", \"organisationUnits\", \"indicators\", \"periodTypes\"","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"","code":"Dhis2r$get_metadata(endpoint = NULL, fields = c(\"name\", \"id\"))"},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"endpoint resource, get available resources using `get_metadata()` without arguments fields specific columns return dataframe e.g c(\"name\",\"id\")","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"returns-2","dir":"Reference","previous_headings":"","what":"Returns","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"data frame","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"method-get-metadata-fields-","dir":"Reference","previous_headings":"","what":"Method get_metadata_fields()","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"Get possible fields specific metadata resource DHIS2 instance","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"","code":"Dhis2r$get_metadata_fields(endpoint)"},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"endpoint resource, get available resources using `get_metadata()` without arguments","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"returns-3","dir":"Reference","previous_headings":"","what":"Returns","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"vector possible fields specific metadata","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"method-get-analytics-","dir":"Reference","previous_headings":"","what":"Method get_analytics()","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"Get possible analytics resources DHIS2 instance .e","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"","code":"Dhis2r$get_analytics( analytic, org_unit, period, output_scheme = c(\"UID\", \"NAME\") )"},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"analytic vector ID specific analytic(s) DHIS2 instance org_unit vector ID specific organisation unit(s) DHIS2 instance period vector relative fixed periods DHIS2 instance output_scheme Output type ID Names fields","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"returns-4","dir":"Reference","previous_headings":"","what":"Returns","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"data frame analytics resource","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"method-get-any-analytic-","dir":"Reference","previous_headings":"","what":"Method get_any_analytic()","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"Get analytics resource DHIS2 instance cater long DHIS2 favorites","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"","code":"Dhis2r$get_any_analytic(endpoint_url)"},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"endpoint_url string part Analytic(s) DHIS2 instance api endpoint starting 'analytics.json?dimension='","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"returns-5","dir":"Reference","previous_headings":"","what":"Returns","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"data frame analytics resource","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"objects class cloneable method.","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"","code":"Dhis2r$clone(deep = FALSE)"},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"arguments-5","dir":"Reference","previous_headings":"","what":"Arguments","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"deep Whether make deep clone.","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/Dhis2r.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Connect and pull/get data from a DHIS2 instance — Dhis2r","text":"","code":"# Load dhis2r library(dhis2r) # connect to the DHIS2 instance dhis2_play_connection <- Dhis2r$new(base_url = \"https://play.im.dhis2.org/stable-2-40-5\", username = \"admin\", password = \"district\") # get all the available resources dhis2_play_connection$get_metadata() #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/resources\" #> # A tibble: 89 × 4 #> displayName singular plural href #> #> 1 Indicator Groups indicatorGroup indic… http… #> 2 Organisation Unit Group Sets organisationUnitGroupSet organ… http… #> 3 Sms Commands smsCommand smsCo… http… #> 4 Program Rules programRule progr… http… #> 5 Category Combos categoryCombo categ… http… #> 6 Validation Notification Templates validationNotificationTemplate valid… http… #> 7 User Roles userRole userR… http… #> 8 Organisation Unit Levels organisationUnitLevel organ… http… #> 9 Program Sections programSection progr… http… #> 10 Option Groups optionGroup optio… http… #> # ℹ 79 more rows # get organisation Units with the default fields i.e c(\"name\",\"id\") dhis2_play_connection$get_metadata(endpoint = \"organisationUnits\") #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/organisationUnits?fields=name%2Cid\" #> # A tibble: 5 × 1 #> `response_data[[1]]` #> #> 1 #> 2 #> 3 #> 4 #> 5 # get a vector of all possible fields of a organisation unit resource dhis2_play_connection$get_metadata_fields(endpoint = \"organisationUnits\") #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/organisationUnits?fields=%3Aall&paging=true&pageSize=1\" #> [1] \"access\" \"ancestors\" \"attributeValues\" #> [4] \"children\" \"code\" \"created\" #> [7] \"dataSets\" \"dimensionItem\" \"dimensionItemType\" #> [10] \"displayFormName\" \"displayName\" \"displayShortName\" #> [13] \"externalAccess\" \"favorite\" \"favorites\" #> [16] \"href\" \"id\" \"lastUpdated\" #> [19] \"leaf\" \"legendSets\" \"level\" #> [22] \"name\" \"openingDate\" \"organisationUnitGroups\" #> [25] \"parent\" \"path\" \"programs\" #> [28] \"sharing\" \"shortName\" \"translations\" #> [31] \"userAccesses\" \"userGroupAccesses\" \"users\" # get organisation Units with additional fields i.e c(\"name\",\"id\", \"level\") dhis2_play_connection$get_metadata(endpoint = \"organisationUnits\", fields = c(\"name\",\"id\", \"level\")) #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/organisationUnits?fields=name%2Cid%2Clevel\" #> # A tibble: 5 × 1 #> `response_data[[1]]` #> #> 1 #> 2 #> 3 #> 4 #> 5 dhis2_play_connection$get_analytics(analytic = c(\"Uvn6LCg7dVU\"), org_unit = c(\"O6uvpzGd5pu\", \"fdc6uOvgoji\"), period = \"LAST_12_MONTHS\", output_scheme = \"NAME\") #> [1] \"https://play.im.dhis2.org/stable-2-40-5/api/analytics?dimension=dx%3AUvn6LCg7dVU&dimension=ou%3AO6uvpzGd5pu%3Bfdc6uOvgoji&dimension=pe%3ALAST_12_MONTHS&outputIdScheme=NAME\" #> # A tibble: 22 × 4 #> analytic org_unit period value #> #> 1 ANC 1 Coverage Bo November 2023 194. #> 2 ANC 1 Coverage Bo December 2023 111. #> 3 ANC 1 Coverage Bo January 2024 127. #> 4 ANC 1 Coverage Bo February 2024 133. #> 5 ANC 1 Coverage Bo March 2024 124. #> 6 ANC 1 Coverage Bo April 2024 133. #> 7 ANC 1 Coverage Bo May 2024 154. #> 8 ANC 1 Coverage Bo June 2024 142. #> 9 ANC 1 Coverage Bo July 2024 171. #> 10 ANC 1 Coverage Bo August 2024 144. #> # ℹ 12 more rows"},{"path":"https://dhis2r.amanyiraho.com/reference/dhis2r-package.html","id":null,"dir":"Reference","previous_headings":"","what":"dhis2r: Client for the 'DHIS2' Web API — dhis2r-package","title":"dhis2r: Client for the 'DHIS2' Web API — dhis2r-package","text":"Connect pull data 'DHIS2 (District Health Information Software 2)' instance R.","code":""},{"path":[]},{"path":"https://dhis2r.amanyiraho.com/reference/dhis2r-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"dhis2r: Client for the 'DHIS2' Web API — dhis2r-package","text":"Maintainer: Robinson Amanyiraho amanyiraho@gmail.com (ORCID) [copyright holder]","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/relative_periods.html","id":null,"dir":"Reference","previous_headings":"","what":"Relative periods in DHIS2 — relative_periods","title":"Relative periods in DHIS2 — relative_periods","text":"relative periods relative current date allow e.g. creating dynamic reports","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/relative_periods.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Relative periods in DHIS2 — relative_periods","text":"","code":"data(relative_periods)"},{"path":"https://dhis2r.amanyiraho.com/reference/relative_periods.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"Relative periods in DHIS2 — relative_periods","text":"data frame 30 rows 2 columns: period_type Period type period Relative period used","code":""},{"path":"https://dhis2r.amanyiraho.com/reference/relative_periods.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"Relative periods in DHIS2 — relative_periods","text":"\"https://docs.dhis2.org/en/develop/using--api/dhis-core-version-239/introduction.html\"","code":""},{"path":"https://dhis2r.amanyiraho.com/news/index.html","id":"dhis2r-021","dir":"Changelog","previous_headings":"","what":"dhis2r 0.2.1","title":"dhis2r 0.2.1","text":"CRAN release: 2024-11-04","code":""},{"path":"https://dhis2r.amanyiraho.com/news/index.html","id":"bug-fix-0-2-1","dir":"Changelog","previous_headings":"","what":"Bug fix","title":"dhis2r 0.2.1","text":"Updated vignette use username password instead PAT since public server regularly updated","code":""},{"path":"https://dhis2r.amanyiraho.com/news/index.html","id":"dhis2r-020","dir":"Changelog","previous_headings":"","what":"dhis2r 0.2.0","title":"dhis2r 0.2.0","text":"CRAN release: 2024-10-29","code":""},{"path":"https://dhis2r.amanyiraho.com/news/index.html","id":"new-features-0-2-0","dir":"Changelog","previous_headings":"","what":"New features","title":"dhis2r 0.2.0","text":"Dhis2r$new() now includes api_token = NULL authentication via personal access token option(@Brar, #12). New dhis2_connection$get_any_analytic() GET long DHIS2 resources. Functions now print resource link queried","code":""},{"path":"https://dhis2r.amanyiraho.com/news/index.html","id":"minor-improvements-and-fixes-0-2-0","dir":"Changelog","previous_headings":"","what":"Minor improvements and fixes","title":"dhis2r 0.2.0","text":"Updated public server URL examples vignettes “https://play.im.dhis2.org/stable-2-40-5”","code":""},{"path":"https://dhis2r.amanyiraho.com/news/index.html","id":"dhis2r-011","dir":"Changelog","previous_headings":"","what":"dhis2r 0.1.1","title":"dhis2r 0.1.1","text":"CRAN release: 2023-02-15 Fix R CMD check failures CRAN. Added NEWS.md file track changes package.","code":""}]
diff --git a/sitemap.xml b/sitemap.xml
index 2cb9e52..2ee712b 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -1,16 +1,16 @@
-http://www.amanyiraho.com/dhis2r/404.html
-http://www.amanyiraho.com/dhis2r/CODE_OF_CONDUCT.html
-http://www.amanyiraho.com/dhis2r/LICENSE-text.html
-http://www.amanyiraho.com/dhis2r/LICENSE.html
-http://www.amanyiraho.com/dhis2r/articles/dhis2r.html
-http://www.amanyiraho.com/dhis2r/articles/index.html
-http://www.amanyiraho.com/dhis2r/authors.html
-http://www.amanyiraho.com/dhis2r/index.html
-http://www.amanyiraho.com/dhis2r/news/index.html
-http://www.amanyiraho.com/dhis2r/reference/Dhis2r.html
-http://www.amanyiraho.com/dhis2r/reference/dhis2r-package.html
-http://www.amanyiraho.com/dhis2r/reference/index.html
-http://www.amanyiraho.com/dhis2r/reference/relative_periods.html
+https://dhis2r.amanyiraho.com/404.html
+https://dhis2r.amanyiraho.com/CODE_OF_CONDUCT.html
+https://dhis2r.amanyiraho.com/LICENSE-text.html
+https://dhis2r.amanyiraho.com/LICENSE.html
+https://dhis2r.amanyiraho.com/articles/dhis2r.html
+https://dhis2r.amanyiraho.com/articles/index.html
+https://dhis2r.amanyiraho.com/authors.html
+https://dhis2r.amanyiraho.com/index.html
+https://dhis2r.amanyiraho.com/news/index.html
+https://dhis2r.amanyiraho.com/reference/Dhis2r.html
+https://dhis2r.amanyiraho.com/reference/dhis2r-package.html
+https://dhis2r.amanyiraho.com/reference/index.html
+https://dhis2r.amanyiraho.com/reference/relative_periods.html