Rename setting to geographic setting

Author: Bisaloo

R/contact_matrix.R

@@ -4,7 +4,7 @@
 #'    data.
 #' @param location Character. One of "all" (default), "home", "school", "work"
 #'   or "other".
-#' @param setting Character. One of "all" (default), "rural", "urban"
+#' @param geographic_setting Character. One of "all" (default), "rural", "urban"
 #' @param data_source Character. Either "202O" (default) or "2017"
 #'
 #' @return A square (16 by 16) matrix containing the contact data between
@@ -22,7 +22,7 @@
 contact_matrix <- function(
   country,
   location = c("all", "home", "school", "work", "other"),
-  setting = c("all", "rural", "urban"),
+  geographic_setting = c("all", "rural", "urban"),
   data_source = c("2020", "2017")
 ) {
 
@@ -35,15 +35,19 @@ contact_matrix <- function(
   data_source <- as.character(data_source)
   data_source <- match.arg(data_source)
 
-  if (data_source != "2020" & !missing(setting)) {
-    stop("`setting` is only defined for `data_source = 2020`", call. = FALSE)
+  if (data_source != "2020" & !missing(geographic_setting)) {
+    stop(
+      "`geographic_setting` is only defined for `data_source = 2020`",
+      call. = FALSE
+    )
   }
 
-  setting <- match.arg(setting)
+  geographic_setting <- match.arg(geographic_setting)
 
   all <- readRDS(
     system.file(
-      "extdata", paste0("contact_", data_source, "_", location, "_", setting, ".rds"),
+      "extdata",
+      paste0("contact_", data_source, "_", location, "_", geographic_setting, ".rds"),
       package = "contactdata"
     )
   )

R/list_countries.R

@@ -24,23 +24,27 @@
 #'   (2021), \doi{10.1371/journal.pcbi.1009098}.
 
 list_countries <- function(
-  setting = c("all", "rural", "urban"),
+  geographic_setting = c("all", "rural", "urban"),
   data_source = c("2020", "2017")
 ) {
 
   # match.arg() only accepts characters in arg
   data_source <- as.character(data_source)
   data_source <- match.arg(data_source)
 
-  if (data_source != "2020" & !missing(setting)) {
-    stop("`setting` is only defined for `data_source = 2020`", call. = FALSE)
+  if (data_source != "2020" & !missing(geographic_setting)) {
+    stop(
+      "`geographic_setting` is only defined for `data_source = 2020`",
+      call. = FALSE
+    )
   }
 
-  setting <- match.arg(setting)
+  geographic_setting <- match.arg(geographic_setting)
 
   all_contacts <- readRDS(
     system.file(
-      "extdata", paste0("contact_", data_source, "_all_", setting, ".rds"),
+      "extdata",
+      paste0("contact_", data_source, "_all_", geographic_setting, ".rds"),
       package = "contactdata"
     )
   )