Correct the R documentation #2712

globaldothealth · Jun 14, 2022 · fcc8d83 · fcc8d83
1 parent 0f87877
commit fcc8d83
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 6 deletions.
diff --git a/api/R/R/constants.R b/api/R/R/constants.R
@@ -1,4 +1,2 @@
 FILTERS <- c("country")
-DISEASE <- "covid-19"
-ENVIRONMENT <- 'production'
 downloadAsync <- "/api/cases/downloadAsync"
diff --git a/api/R/R/get_cached_cases.R b/api/R/R/get_cached_cases.R
@@ -1,5 +1,5 @@
 get_cached_cases <-
-function(apikey, disease = DISEASE, environment = ENVIRONMENT, refresh = FALSE, folder = "cache", ...) {
+function(apikey, disease = 'covid-19', environment = 'production', refresh = FALSE, folder = "cache", ...) {
     if(!file.exists(folder)) {
         dir.create(folder)
     }

diff --git a/api/R/R/get_cases.R b/api/R/R/get_cases.R
@@ -1,5 +1,5 @@
 get_cases <-
-function(apikey, disease = DISEASE, environment = ENVIRONMENT, ...) {
+function(apikey, disease = 'covid-19', environment = 'production', ...) {
     server <- get_server(disease, environment)
     data <- sprintf('{"format": "csv", "query": "%s"}', trimws(stringify_filters(...)))
     res <- POST(paste0(server, downloadAsync), body = data,

diff --git a/api/R/man/get_cached_cases.Rd b/api/R/man/get_cached_cases.Rd
@@ -13,7 +13,7 @@ Unless you always need to be working with the latest data, we recommend
 using this function instead of \code{\link{get_cases}}.
 }
 \usage{
-get_cached_cases(apikey, disease = 'covid-19', refresh = FALSE, folder = "cache", \dots)
+get_cached_cases(apikey, disease = 'covid-19', environment = 'production', refresh = FALSE, folder = "cache", \dots)
 }
 \arguments{
   \item{apikey}{
@@ -23,6 +23,9 @@ and clicking on Profile.
 }
   \item{disease}{
 Identify the outbreak for which you want to fetch data; the default is COVID-19.
+}
+  \item{environment}{
+Specify the environment whose data you want to use: default is production, alternatives are dev or qa.
 }
   \item{refresh}{
 Optional, if set to TRUE, refreshes the cache and returns the latest version of

diff --git a/api/R/man/get_cases.Rd b/api/R/man/get_cases.Rd
@@ -10,7 +10,7 @@ Unless you always need to be working with the latest data, we recommend
 using \code{\link{get_cached_cases}} instead of this function.
 }
 \usage{
-get_cases(apikey, disease = 'covid-19', \dots)
+get_cases(apikey, disease = 'covid-19', environment = 'production', \dots)
 }
 %- maybe also 'usage' for other objects documented here.
 \arguments{
@@ -20,6 +20,9 @@ up at \url{https://data.covid-19.global.health} and clicking on Profile.
 }
   \item{disease}{
 Identify the outbreak for which you want to fetch data; the default is COVID-19.
+}
+  \item{environment}{
+Specify the environment whose data you want to use: default is production, alternatives are dev or qa.
 }
   \item{\dots}{
 Filters to use for data. Currently the only supported filter is 'country'