From ca7cdf6f56d2f902ad3a7c04e9b6eba46d77580e Mon Sep 17 00:00:00 2001 From: Mohamed Yusuf Date: Fri, 5 Apr 2024 15:17:19 +0100 Subject: [PATCH] Update Roxygden version --- .DS_Store | Bin 8196 -> 8196 bytes DESCRIPTION | 2 +- README.md | 57 ++++++++++++----------- tests/testthat/test-get_polis_api_data.R | 1 - 4 files changed, 30 insertions(+), 30 deletions(-) diff --git a/.DS_Store b/.DS_Store index 58fe32c5ac4b9eb72c287aa63e8354b79913d660..b7612e9eaaaf27a82992a4ff33d1f91df3cdeeae 100644 GIT binary patch delta 493 zcmZp1XmQw}ASliBBdH)Kv$({-;07ZTGYcylI|nBhw^(opSJ-50!3G{Fd1Vbj4Px#vno{}5vovAi;F8HJ2NjupqLY)RZpKw zEHo!EDK$qRg%hYv256D7371%SS!z*nW`3T4H%JsHXkp1EHhH6vu&=G1m{=UhGM~ia z690nKJfK4k0&N64Tt>`=gCi0o>zI;~ngZ78<}M}{Rh*GnlHZ+Lo^WdYQ-D{9|>nEIG=F=<3h$&jH?;f zFm7Yq&v=UQ4C7hGbBxy+UoyU8e9icUiJggqiIa(oNtj83Nm79U444=pG($L)hEhyg an=M4nGf!-g+srQUjb*d6=o_Yq4blL*%yf+a delta 514 zcmXYrO=uHQ6ou!!sb=Qc*h!6PUj3Oifhr_IDrmJ8Os!(=pR}~Lja8ZWp87D!v@=u1 zZYmPpx|ofiZe15bQMW3%Q;>r01gWkHf(utInoQ;{?t$;S7fv-_&98OE4ycLZVoADQ zF82*YZP~RuqUm%GyE04X{ejrS)8N1prLyo9#u4w^2a+J|&SFQ-d z3JH{VY7Q8t^oCmdJW6=O7{17|3kyJ?rpqT;zR zWJ8=EWXxY{k52{VO?FY!<{M20ITw5*+L26L8ey#9-mx5U`F=$>#+OFBI-jWX8%A4T z#w^#nz@=w9p`5BqKe11&ZYh71ZDmLK2L(FXVWJx;q>;rboJK!}FpLq5Vhl4VU;)=~ z9k)@2jYTYB1&>h0V?4oAJi~Lmz)QTsI$q-q-r^nJ;{!h7D}G=TKk*B{2?!x7X(cA< mBHbj_Loy^sdX-=ZnyD1R41=7jb;dudwMg=BOYM6+qW%Z6D|uG{ diff --git a/DESCRIPTION b/DESCRIPTION index ea66016..80fbbf6 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -14,7 +14,7 @@ Description: This R package makes it easy to download Polio data from the WHO License: MIT + file LICENSE Encoding: UTF-8 Roxygen: list(markdown = TRUE) -RoxygenNote: 7.3.0 +RoxygenNote: 7.3.1 Suggests: RcppSimdJson, dplyr, diff --git a/README.md b/README.md index 777137e..b5df248 100644 --- a/README.md +++ b/README.md @@ -53,9 +53,10 @@ The package offers two primary methods for POLIS API interaction: Retrieve data directly from the POLIS API for immediate analysis. -- Suitable for one-off data extraction or personal data handling. - -- Offers detailed control over data retrieval parameters. +- Suitable for complete data downloads (each time). +- Good for complete downloads if using snaphots. +- Offers detailed control over data retrieval parameters. +- Has functionality to log file downloads. #### Usage Example @@ -65,19 +66,20 @@ data <- get_polis_api_data( min_date = "2021-01-01", max_date = "2021-01-31", data_type = "cases", - region = 'AFRO', + region = 'AFRO', select_vars = NULL, - polis_api_key = my_token + polis_api_key = my_token, + log_results = TRUE, + log_file_path = "my_log_path/polis_log.rds" ) ``` ### 2. Data Updates: `update_polis_api_data` Use this for periodic data updates, minimizing redundant retrievals. - -- Checks for existing data and fetches new records. - -- Features built-in logging for update tracking. +- Checks for existing data and fetches new records. +- Good when you need to quickly update your polis data. +- Features built-in logging for update tracking. #### Usage Example @@ -100,24 +102,23 @@ update_polis_api_data( The POLIS API provides diverse datasets for download: -- **Cases Data (`"cases"`):** Detailed polioviruses cases data. -- **Virus Data (`"virus"`):** Virus are all data related with Viruses. -- **Population Data (`"population"`):** Data on all references - population used in POLIS. -- **Environmental Data (`"env"`):** Data on all environmental samples - collected. -- **Geographical Data (`"geo"`):** All references places used in - POLIS. -- **Geographical Synonym Data (`"geo_synonym"`):** Alternate location - names. -- **Independent Monitoring Data (`"im"`):** Describes quality after - vaccination campaigns. -- **Activity Data (`"activity"`):** Information all actions taken - against Poliovirus -- **Sub-activities Data (`"sub_activ"`):** Details on specific - sub-activities taken against Poliovirus. -- **Lot Quality Assurance Sampling Data (`"lqas"`):** Describes - quality of vaccination campaigns. -- **Lab Specimen Data (Human & Viruses) (`"lab_specimen"` & +- **Cases Data (`"cases"`):** Detailed polioviruses cases data. +- **Virus Data (`"virus"`):** Virus are all data related with Viruses. +- **Population Data (`"population"`):** Data on all references + population used in POLIS. +- **Environmental Data (`"env"`):** Data on all environmental samples + collected. +- **Geographical Data (`"geo"`):** All references places used in + POLIS. +- **Geographical Synonym Data (`"geo_synonym"`):** Alternate location + names. +- **Activity Data (`"activity"`):** Information all SIA actions taken. +- **Sub-activities Data (`"sub_activ"`):** Details on specific SIA + sub-activities taken. +- **Lot Quality Assurance Sampling Data (`"lqas"`):** Datasets on the + quality of vaccination campaigns. +- **Independent Monitoring Data (`"im"`):** Datasets on the quality after + vaccination campaigns. +- **Lab Specimen Data (Human & Viruses) (`"lab_specimen"` & `"lab_specimen_virus"`):** Details on human specimens and viruses; all specimens sent to laboratories to be investigated diff --git a/tests/testthat/test-get_polis_api_data.R b/tests/testthat/test-get_polis_api_data.R index 3afeeae..3dfd9a7 100644 --- a/tests/testthat/test-get_polis_api_data.R +++ b/tests/testthat/test-get_polis_api_data.R @@ -24,7 +24,6 @@ testthat::test_that("get_polis_api_data returns correct data structure", { # Test the function result <- get_polis_api_data("2021-01-01", - "2021-01-31", "cases", "AFRO") # Assertions