Merge pull request #90 from getwilds/dev

Dev to main
getwilds · Mar 21, 2024 · 7da998f · 7da998f
2 parents e5df87e + c6619b2
commit 7da998f
Show file tree

Hide file tree

Showing 47 changed files with 1,508 additions and 408 deletions.
diff --git a/.Rapp.history b/.Rapp.history
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -5,3 +5,5 @@
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$
+^man-roxygen$
+^vignettes/\.RData$
diff --git a/.lintr b/.lintr
@@ -0,0 +1,4 @@
+linters: linters_with_defaults(
+    line_length_linter(120),
+    cyclocomp_linter(complexity_limit = 150)
+  )
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -24,3 +24,5 @@ Suggests:
     testthat
 Config/testthat/edition: 3
 VignetteBuilder: knitr
+Depends: 
+    R (>= 2.10)
diff --git a/R/.lintr b/R/.lintr
@@ -0,0 +1,4 @@
+linters: linters_with_defaults(
+  line_length_linter(120),
+  cyclocomp_linter(complexity_limit = 150)
+)
diff --git a/R/demo-crowding.R b/R/demo-crowding.R
@@ -4,10 +4,7 @@
 #' Cancer Profiles.
 #'
 #' @param area A state/territory abbreviation or USA.
-#' @param areatype One of the following values:
-#' - `"county"`
-#' - `"hsa"` (Health Service Area)
-#' - `"state"`.
+#' @template param-areatype
 #' @param crowding The only permissible value is
 #' `"household with >1 person per room"`.
 #' @param race
@@ -26,7 +23,7 @@
 #'
 #' @returns A data frame with the following columns: Area, Area Code,
 #' Percent, Households, Rank.
-#' 
+#'
 #' @family demographics
 #'
 #' @export
@@ -55,7 +52,6 @@
 #' )
 #' }
 demo_crowding <- function(area, areatype, crowding, race) {
-
   req <- create_request("demographics")
 
   resp <- req %>%
@@ -74,13 +70,9 @@ demo_crowding <- function(area, areatype, crowding, race) {
 
   resp <- process_resp(resp, "demographics")
 
-  area_type <- get_area(areatype)[1]
-  area_code <- get_area(areatype)[2]
-
   resp %>%
     setNames(c(
-      area_type,
-      area_code,
+      get_area(areatype),
       "Percent",
       "Households",
       "Rank"

diff --git a/R/demo-education.R b/R/demo-education.R
@@ -4,18 +4,12 @@
 #' State Cancer Profiles.
 #'
 #' @param area A state/territory abbreviation or USA.
-#' @param areatype One of the following values:
-#' - `"county"`
-#' - `"hsa"` (Health Service Area)
-#' - `"state"`.
+#' @template param-areatype
 #' @param education One of the following values:
 #' - `"less than 9th grade"`
 #' - `"at least high school"`
 #' - `"at least bachelors degree"`.
-#' @param sex One of the following values:
-#' - `"both sexes"`
-#' - `"male"`
-#' - `"female"`.
+#' @template param-sex
 #' @param race One of the following values:
 #' - `"All Races (includes Hispanic)"`
 #' - `"White (includes Hispanic)"`
@@ -31,7 +25,7 @@
 #'
 #' @returns A data frame with the following columns:
 #' Area Type, Area Code, Percent, Households, Rank.
-#' 
+#'
 #' @family demographics
 #'
 #' @export
@@ -96,17 +90,13 @@ demo_education <- function(area, areatype, education, sex = NULL, race = NULL) {
     req_perform()
 
   resp <- process_resp(resp, "demographics")
-
-  area_type <- get_area(areatype)[1]
-  area_code <- get_area(areatype)[2]
 
   resp %>%
     setNames(c(
-      area_type,
-      area_code,
+      get_area(areatype),
       "Percent",
       "Households",
       "Rank"
-    )) %>% 
+    )) %>%
     mutate(across(c("Percent", "Households"), \(x) as.numeric(x)))
 }
diff --git a/R/demo-food-access.R b/R/demo-food-access.R
@@ -21,7 +21,7 @@
 #'
 #' @returns A data frame with the following columns:
 #' Area Type, Area Code, Value, People.
-#' 
+#'
 #' @family demographics
 #'
 #' @export
@@ -79,16 +79,13 @@ demo_food <- function(area, areatype, food, race = NULL) {
 
   resp <- process_resp(resp, "demographics")
 
-  area_type <- get_area(areatype)[1]
-  area_code <- get_area(areatype)[2]
-
   if (food == "limited access to healthy food") {
     resp %>%
-      setNames(c(area_type, area_code, "Percent", "People")) %>% 
+      setNames(c(get_area(areatype), "Percent", "People")) %>%
       mutate(across(c("Percent", "People"), \(x) as.numeric(x)))
   } else if (food == "food insecurity") {
     resp %>%
-      setNames(c(area_type, area_code, "Percent")) %>% 
+      setNames(c(get_area(areatype), "Percent")) %>%
       mutate(across(c("Percent"), \(x) as.numeric(x)))
   }
 }
diff --git a/R/demo-income.R b/R/demo-income.R
@@ -21,7 +21,7 @@
 #'
 #' @returns A data frame with the following columns:
 #' Area Type, Area Code, Dollars, Rank.
-#' 
+#'
 #' @family demographics
 #'
 #' @export
@@ -68,10 +68,7 @@ demo_income <- function(area, areatype, income, race) {
 
   resp <- process_resp(resp, "demographics")
 
-  area_type <- get_area(areatype)[1]
-  area_code <- get_area(areatype)[2]
-
   resp %>%
-    setNames(c(area_type, area_code, "Dollars", "Rank")) %>% 
+    setNames(c(get_area(areatype), "Dollars", "Rank")) %>%
     mutate(across(c("Dollars"), \(x) as.numeric(x)))
 }
diff --git a/R/demo-insurance.R b/R/demo-insurance.R
@@ -4,10 +4,7 @@
 #' from State Cancer Profiles.
 #'
 #' @param area A state/territory abbreviation or USA.
-#' @param areatype One of the following values:
-#' - `"county"`
-#' - `"hsa"` (Health Service Area)
-#' - `"state"`.
+#' @template param-areatype
 #' @param insurance One of the following values:
 #' - `"% Insured in demographic group, all income levels"`
 #' - `"% Insured in demographic group, people at or below 138% of Poverty"`
@@ -21,10 +18,7 @@
 #' - `"% uninsured in demographic group, people at or below 250% of Poverty"`
 #' - `"% uninsured in demographic group, people at or below 400% of Poverty"`
 #' - `"% uninsured in demographic group, people between 138% - 400% of poverty"`.
-#' @param sex One of the following values:
-#' - `"both sexes"`
-#' - `"male"`
-#' - `"female"`.
+#' @template param-sex
 #' @param age If you specified `"both sexes"` for `sex`
 #' choose one of the following values:
 #' - `"under 19 years"`
@@ -55,7 +49,7 @@
 #'
 #' @returns A data frame with the following columns:
 #' Area Type, Area Code, Percent, People, Rank.
-#' 
+#'
 #' @family demographics
 #'
 #' @export
@@ -132,10 +126,7 @@ demo_insurance <- function(area, areatype, insurance, sex, age, race = NULL) {
 
   resp <- process_resp(resp, "demographics")
 
-  area_type <- get_area(areatype)[1]
-  area_code <- get_area(areatype)[2]
-
   resp %>%
-    setNames(c(area_type, area_code, "Percent", "People", "Rank")) %>% 
+    setNames(c(get_area(areatype), "Percent", "People", "Rank")) %>%
     mutate(across(c("Percent", "People"), \(x) as.numeric(x)))
 }
diff --git a/R/demo-mobility.R b/R/demo-mobility.R
@@ -4,10 +4,7 @@
 #' from State Cancer Profiles.
 #'
 #' @param area A state/territory abbreviation or USA.
-#' @param areatype One of the following values:
-#' - `"county"`
-#' - `"hsa"` (Health Service Area)
-#' - `"state"`.
+#' @template param-areatype
 #' @param mobility The only permissible values are
 #' - `"i haven't moved (in past year)"`
 #' - `"moved from outside us (in past year)"`
@@ -21,7 +18,7 @@
 #'
 #' @returns A data frame with the following columns:
 #' Area Type, Area Code, Percent, People, Rank.
-#' 
+#'
 #' @family demographics
 #'
 #' @export
@@ -64,16 +61,12 @@ demo_mobility <- function(area, areatype, mobility) {
 
   resp <- process_resp(resp, "demographics")
 
-  area_type <- get_area(areatype)[1]
-  area_code <- get_area(areatype)[2]
-
   resp %>%
     setNames(c(
-      area_type,
-      area_code,
+      get_area(areatype),
       "Percent",
       "People",
       "Rank"
-    )) %>% 
+    )) %>%
     mutate(across(c("Percent", "People"), \(x) as.numeric(x)))
 }
diff --git a/R/demo-non-english-language.R b/R/demo-non-english-language.R
@@ -4,10 +4,7 @@
 #' from State Cancer Profiles.
 #'
 #' @param area A state/territory abbreviation or USA.
-#' @param areatype One of the following values:
-#' - `"county"`
-#' - `"hsa"` (Health Service Area)
-#' - `"state"`.
+#' @template param-areatype
 #' @param language The only permissible value is
 #' `"language isolation"`.
 #'
@@ -17,7 +14,7 @@
 #'
 #' @returns A data frame with the following columns:
 #' Area Type, Area Code, Percent, Households, Rank.
-#' 
+#'
 #' @family demographics
 #'
 #' @export
@@ -58,16 +55,12 @@ demo_language <- function(area, areatype, language) {
 
   resp <- process_resp(resp, "demographics")
 
-  area_type <- get_area(areatype)[1]
-  area_code <- get_area(areatype)[2]
-
   resp %>%
     setNames(c(
-      area_type,
-      area_code,
+      get_area(areatype),
       "Percent",
       "Households",
       "Rank"
-    )) %>% 
+    )) %>%
     mutate(across(c("Percent", "Households"), \(x) as.numeric(x)))
 }
diff --git a/R/demo-population.R b/R/demo-population.R
@@ -4,10 +4,7 @@
 #' from State Cancer Profiles.
 #'
 #' @param area A state/territory abbreviation or USA.
-#' @param areatype One of the following values:
-#' - `"county"`
-#' - `"hsa"` (Health Service Area)
-#' - `"state"`.
+#' @template param-areatype
 #' @param population One of the following values:
 #' - `"age under 18"`
 #' - `"age 18-39"`
@@ -32,10 +29,7 @@
 #' - `"White (includes Hispanic)"`
 #' - `"White non-Hispanic"`
 #' - `"Hispanic (Any Race)"`.
-#' @param sex One of the following values:
-#' - `"both sexes"`
-#' - `"male"`
-#' - `"female"`.
+#' @template param-sex
 #'
 #' @importFrom httr2 req_url_query req_perform
 #' @importFrom cli cli_abort
@@ -44,7 +38,7 @@
 #'
 #' @returns A data frame with the following columns:
 #' Area Type, Area Code, Percent, Households, Rank.
-#' 
+#'
 #' @family demographics
 #'
 #' @export
@@ -87,9 +81,9 @@ demo_population <- function(area, areatype, population, race = NULL, sex = NULL)
     cli_abort("for males, Race must not be NULL and Sex must be NULL")
   } else if (population == "foreign born" && (is.null(race) || is.null(sex))) {
     cli_abort("for foreign born, race and sex must not be NULL")
-  } else if ((population == "american indian/alaska native" || population == "asian/pacific islander" || population == "black" ||
-    population == "hispanic" || population == "non-hispanic (origin recode)" ||
-    population == "white") && (is.null(sex) || !is.null(race))) {
+  } else if ((population == "american indian/alaska native" || population == "asian/pacific islander" ||
+                population == "black" || population == "hispanic" || population == "non-hispanic (origin recode)" ||
+                population == "white") && (is.null(sex) || !is.null(race))) {
     cli_abort("for races other than foreign born, Sex must not be NULL and race must be NULL")
   }
 
@@ -117,19 +111,15 @@ demo_population <- function(area, areatype, population, race = NULL, sex = NULL)
 
   resp <- resp %>%
     req_perform()
-
-  resp <- process_resp(resp, "demographics")
 
-  area_type <- get_area(areatype)[1]
-  area_code <- get_area(areatype)[2]
+  resp <- process_resp(resp, "demographics")
 
   resp %>%
     setNames(c(
-      area_type,
-      area_code,
+      get_area(areatype),
       "Percent",
       "People",
       "Rank"
-    )) %>% 
+    )) %>%
     mutate(across(c("Percent", "People"), \(x) as.numeric(x)))
 }