From f9a4e875852f076999904ece4349d5b1c4fec647 Mon Sep 17 00:00:00 2001 From: realbp Date: Wed, 6 Mar 2024 11:48:24 -0800 Subject: [PATCH 1/3] edited demo documentations --- NAMESPACE | 1 + R/demo-education.R | 28 ++++++++++++----- R/demo-food-access.R | 15 +++++---- R/demo-income.R | 19 +++++++----- R/demo-insurance.R | 49 ++++++++++++++++++++++-------- R/demo-mobility.R | 16 ++++++---- R/demo-non-english-language.R | 10 +++--- R/handle-race.R | 2 +- man/demo_crowding.Rd | 35 +++++++++++++-------- man/demo_education.Rd | 34 ++++++++++++++++----- man/demo_food.Rd | 17 +++++++---- man/demo_income.Rd | 21 ++++++++----- man/demo_insurance.Rd | 57 +++++++++++++++++++++++++++-------- 13 files changed, 213 insertions(+), 91 deletions(-) diff --git a/NAMESPACE b/NAMESPACE index 4b1f7ff..a13ac55 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -22,6 +22,7 @@ export(risk_vaccines) export(risk_women_health) importFrom(cdlTools,fips) importFrom(cli,cli_abort) +importFrom(dplyr,across) importFrom(dplyr,filter) importFrom(dplyr,mutate) importFrom(dplyr,mutate_all) diff --git a/R/demo-education.R b/R/demo-education.R index f8b7f33..8107e84 100644 --- a/R/demo-education.R +++ b/R/demo-education.R @@ -1,20 +1,32 @@ #' Access to Education Data #' -#' This function returns a data frame from Education in State Cancer Profiles +#' This function returns a data frame about education demographics from State Cancer Profiles. #' #' @param area A state/territory abbreviation or USA. -#' @param areatype Either "county", "hsa" (Health service area), or "state" -#' @param education Either "less than 9th grade", "at least high school", "at least bachelors degree" -#' @param sex Either "both sexes", "male", "female" -#' @param race One of the following values: "All Races (includes Hispanic)", "white (includes hispanic)", -#' "white non-hispanic","black","amer. indian/alaskan native (includes hispanic)", -#' "asian or pacific islander (includes hispanic)","hispanic (any race) +#' @param areatype Either `"county"`, `"hsa"` (Health Service Area), or +#' `"state"`. +#' @param education The only permissible values are +#' - `"less than 9th grade"` +#' - `"at least high school"` +#' - `"at least bachelors degree"` +#' @param sex One of the following values: +#' - "both sexes" +#' - "male" +#' - "female" +#' @param race One of the following values: +#' - "All Races (includes Hispanic)" +#' - "White (includes Hispanic)" +#' - "White non-Hispanic" +#' - "Black" +#' - "Amer. Indian/Alaskan Native (includes Hispanic)" +#' - "Asian or Pacific Islander (includes Hispanic)" +#' - "hispanic (Any Race) #' #' @importFrom httr2 req_url_query req_perform #' @importFrom cli cli_abort #' @importFrom stats setNames #' -#' @returns A data frame with the following columns: Area Type, Area Code, "Percent", "Households", "Rank" +#' @returns A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank #' #' @export #' diff --git a/R/demo-food-access.R b/R/demo-food-access.R index b0cfb9c..dfc01cf 100644 --- a/R/demo-food-access.R +++ b/R/demo-food-access.R @@ -1,19 +1,22 @@ #' Access to Food Insecurity Data #' -#' This function returns a data frame from Food Insecurity in State Cancer Profiles +#' This function returns a data frame about Food Insecurity from State Cancer Profiles. #' #' @param area A state/territory abbreviation or USA. -#' @param areatype Either "county" or "state" -#' @param food Either "food insecurity" or "limited access to healthy food" -#' @param race One of the following values: "All Races (includes Hispanic)", "white non hispanic", -#' "black (includes hispanic)","hispanic (any race) +#' @param areatype Either `"county"` or `"state"` +#' @param food Either `"food insecurity"` or `"limited access to healthy food"` +#' @param race One of the following values: +#' - "All Races (includes Hispanic)" +#' - "White non-Hispanic" +#' - "Black (includes Hispanic)" +#' - "Hispanic (Any Race) #' #' @importFrom httr2 req_url_query req_perform #' @importFrom cli cli_abort #' @importFrom dplyr mutate #' @importFrom stats setNames #' -#' @returns A data frame with the following columns: Area Type, Area Code, "Value", "People" +#' @returns A data frame with the following columns: Area Type, Area Code, Value, People" #' #' @export #' diff --git a/R/demo-income.R b/R/demo-income.R index 6ef54a7..1720284 100644 --- a/R/demo-income.R +++ b/R/demo-income.R @@ -1,20 +1,25 @@ #' Access to Income Data #' -#' This function returns a data frame from Income in State Cancer Profiles +#' This function returns a data frame about income demographics from State Cancer Profiles. #' #' @param area A state/territory abbreviation or USA. -#' @param areatype Either "county" or "state" -#' @param income Either "median family income" or "median household income" -#' @param race One of the following values: "All Races (includes Hispanic)", "white (includes hispanic)", -#' "white non-hispanic","black","amer. indian/alaskan native (includes hispanic)", -#' "asian or pacific islander (includes hispanic)","hispanic (any race) +#' @param areatype Either `"county"` or `"state"` +#' @param income Either `"median family income"` or `"median household income"` +#' @param race One of the following values: +#' - "All Races (includes Hispanic)" +#' - "White (includes Hispanic)" +#' - "White non-Hispanic" +#' - "Black" +#' - "Amer. Indian/Alaskan Native (includes Hispanic)" +#' - "Asian or Pacific Islander (includes Hispanic)" +#' - "hispanic (Any Race) #' #' @importFrom httr2 req_url_query req_perform #' @importFrom cli cli_abort #' @importFrom dplyr mutate #' @importFrom stats setNames #' -#' @returns A data frame with the following columns: Area Type, Area Code, "Dollars", "Rank" +#' @returns A data frame with the following columns: Area Type, Area Code, Dollars, Rank #' #' @export #' diff --git a/R/demo-insurance.R b/R/demo-insurance.R index b19dac5..7af0bc1 100644 --- a/R/demo-insurance.R +++ b/R/demo-insurance.R @@ -1,21 +1,44 @@ #' Access to Insurance Data #' -#' This function returns a data frame from Insurance in State Cancer Profiles +#' This function returns a data frame about insurance demographics from State Cancer Profiles. #' #' @param area A state/territory abbreviation or USA. -#' @param areatype Either "county", "hsa" (Health service area), or "state" -#' @param insurance Either -#' "% Insured in demographic group, all income levels", "% Insured in demographic group, people at or below 138% of Poverty" -#' "% Insured in demographic group, people at or below 200% of Poverty", "% Insured in demographic group, people at or below 250% of Poverty" -#' "% Insured in demographic group, people at or below 400% of Poverty","% Insured in demographic group, people between 138% - 400% of poverty" -#' "% uninsured in demographic group, all income levels","% uninsured in demographic group, people at or below 138% of Poverty" -#' "% uninsured in demographic group, people at or below 200% of Poverty","% 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 areatype Either `"county"`, `"hsa"` (Health Service Area), or +#' `"state"`. +#' @param insurance The only permissible values are: +#' - `"% Insured in demographic group, all income levels"` +#' - `"% Insured in demographic group, people at or below 138% of Poverty"` +#' - `"% Insured in demographic group, people at or below 200% of Poverty"` +#' - `"% Insured in demographic group, people at or below 250% of Poverty"` +#' - `"% Insured in demographic group, people at or below 400% of Poverty"` +#' - `"% Insured in demographic group, people between 138% - 400% of poverty"` +#' - `"% uninsured in demographic group, all income levels"` +#' - `"% uninsured in demographic group, people at or below 138% of Poverty"` +#' - `"% uninsured in demographic group, people at or below 200% of Poverty"` +#' - `"% 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 Either "both sexes", "male", "female" -#' @param age Either "under 19 years", "18 to 64 years","21 to 64 years","40 to 64 years","50 to 64 years","under 65 years" for "both sexes" -#' "18 to 64 years","40 to 64 years","50 to 64 years","Under 65 years" for "males" and "females" -#' @param race Either "all races (includes hispanic)", "white (non-hispanic)", "black (non-hispanic)", "american indian / alaska native non-hispanic", -#' "asian (non-hispanic)", "hispanic (any race)" +#' @param age The only permissible values for "both sexes" are: +#' - "under 19 years" +#' - "18 to 64 years" +#' - "21 to 64 years" +#' - "40 to 64 years" +#' - "50 to 64 years" +#' - "under 65 years" +#' +#' The only permissible values for "males" and "females" are: +#' - "18 to 64 years" +#' - "40 to 64 years" +#' - "50 to 64 years" +#' - "Under 65 years" +#' @param race One of the following values: +#' - All Races (includes Hispanic)" +#' - "White (non-Hispanic)" +#' - "black (non-Hispanic)" +#' - "American Indian / Alaska Native (non-Hispanic)" +#' - "Asian (non-Hispanic)" +#' - "Hispanic (Any Race)" #' #' @importFrom httr2 req_url_query req_perform #' @importFrom cli cli_abort diff --git a/R/demo-mobility.R b/R/demo-mobility.R index 29c83de..4dc1733 100644 --- a/R/demo-mobility.R +++ b/R/demo-mobility.R @@ -1,18 +1,22 @@ #' Access to Mobility Data #' -#' This function returns a data frame from mobility in State Cancer Profiles +#' This function returns a data frame about mobility demographics from State Cancer Profiles. #' #' @param area A state/territory abbreviation or USA. -#' @param areatype Either "county", "hsa" (Health service area), or "state" -#' @param mobility One of five choices from "i haven't moved (in past year)", "moved from outside us (in past year)", -#' "moved, different state (in past year)", "moved, different county, same state (in past year)", -#' "moved, same county (in past year)" +#' @param areatype Either `"county"`, `"hsa"` (Health Service Area), or +#' `"state"`. +#' @param mobility The only permissible values are +#' -` "i haven't moved (in past year)"` +#' - `"moved from outside us (in past year)"` +#' - `"moved, different state (in past year)"` +#' - `"moved, different county, same state (in past year)"` +#' - `"moved, same county (in past year)"` #' #' @importFrom httr2 req_url_query req_perform #' @importFrom cli cli_abort #' @importFrom stats setNames #' -#' @returns A data frame with the following columns: Area Type, Area Code, "Percent", "People", "Rank" +#' @returns A data frame with the following columns: Area Type, Area Code, Percent, People, Rank #' #' @export #' diff --git a/R/demo-non-english-language.R b/R/demo-non-english-language.R index 8b968fe..eb91dec 100644 --- a/R/demo-non-english-language.R +++ b/R/demo-non-english-language.R @@ -1,15 +1,17 @@ #' Access to Non-English Language #' -#' This function returns a data frame from Crowding in State Cancer Profiles +#' This function returns a data frame about language demographics from State Cancer Profiles. #' #' @param area A state/territory abbreviation or USA. -#' @param areatype Either "county", "hsa" (Health service area), or "state" -#' @param language "language isolation" +#' @param areatype Either `"county"`, `"hsa"` (Health Service Area), or +#' `"state"`. +#' @param language The only permissible value is +#' `"language isolation"` #' #' @importFrom httr2 req_url_query req_perform #' @importFrom stats setNames #' -#' @returns A data frame with the following columns: Area Type, Area Code, "Percent", "Households", "Rank" +#' @returns A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank #' #' @export #' diff --git a/R/handle-race.R b/R/handle-race.R index 79db7eb..ea0d5e9 100644 --- a/R/handle-race.R +++ b/R/handle-race.R @@ -38,7 +38,7 @@ handle_race <- function(race) { "white (non-hispanic)" = "07", "black (non-hispanic)" = "28", "amer. indian / ak native (non-hispanic)" = "38", - "american indian / alaska native non-hispanic" = "38", + "american indian / alaska native (non-hispanic)" = "38", "asian / pacific islander (non-hispanic)" = "48", "asian (non-hispanic)" = "49" diff --git a/man/demo_crowding.Rd b/man/demo_crowding.Rd index c28b07a..a7245c8 100644 --- a/man/demo_crowding.Rd +++ b/man/demo_crowding.Rd @@ -4,29 +4,40 @@ \alias{demo_crowding} \title{Access to Crowding Data} \usage{ -demo_crowding(area, areatype, crowding, race) +demo_crowding( + area, + areatype, + crowding = "household with >1 person per room", + race +) } \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either "county", "hsa" (Health service area), or "state"} +\item{areatype}{Either \code{"county"}, \code{"hsa"} (Health Service Area), or +\code{"state"}.} -\item{crowding}{"household with >1 person per room"} +\item{crowding}{The only permissible value is +\code{"household with >1 person per room"}.} \item{race}{One of the following values: -"All Races (includes Hispanic)", -"white (includes hispanic)", -"white non-hispanic", -"black", -"amer. indian/alaskan native (includes hispanic)", -"asian or pacific islander (includes hispanic)", -"hispanic (any race)"} +\itemize{ +\item "All Races (includes Hispanic)" +\item "White (includes Hispanic)" +\item "White Non-Hispanic" +\item "Black" +\item "Amer. Indian/Alaskan Native (includes Hispanic)" +\item "Asian or Pacific Islander (includes Hispanic)" +\item "Hispanic (Any Race)" +}} } \value{ -A data frame with the following columns Area, Area Code, "Percent", "Households", "Rank" +A data frame with the following columns: Area, Area Code, +Percent, Households, Rank. } \description{ -This function returns a data frame from Crowding in State Cancer Profiles +This function returns a data frame about crowding demographics from State +Cancer Profiles. } \examples{ \dontrun{ diff --git a/man/demo_education.Rd b/man/demo_education.Rd index 1ee41cd..d720b13 100644 --- a/man/demo_education.Rd +++ b/man/demo_education.Rd @@ -9,21 +9,39 @@ demo_education(area, areatype, education, sex = NULL, race = NULL) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either "county", "hsa" (Health service area), or "state"} +\item{areatype}{Either \code{"county"}, \code{"hsa"} (Health Service Area), or +\code{"state"}.} -\item{education}{Either "less than 9th grade", "at least high school", "at least bachelors degree"} +\item{education}{The only permissible values are +\itemize{ +\item \code{"less than 9th grade"} +\item \code{"at least high school"} +\item \code{"at least bachelors degree"} +}} -\item{sex}{Either "both sexes", "male", "female"} +\item{sex}{One of the following values: +\itemize{ +\item "both sexes" +\item "male" +\item "female" +}} -\item{race}{One of the following values: "All Races (includes Hispanic)", "white (includes hispanic)", -"white non-hispanic","black","amer. indian/alaskan native (includes hispanic)", -"asian or pacific islander (includes hispanic)","hispanic (any race)} +\item{race}{One of the following values: +\itemize{ +\item "All Races (includes Hispanic)" +\item "White (includes Hispanic)" +\item "White non-Hispanic" +\item "Black" +\item "Amer. Indian/Alaskan Native (includes Hispanic)" +\item "Asian or Pacific Islander (includes Hispanic)" +\item "hispanic (Any Race) +}} } \value{ -A data frame with the following columns: Area Type, Area Code, "Percent", "Households", "Rank" +A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank } \description{ -This function returns a data frame from Education in State Cancer Profiles +This function returns a data frame about education demographics from State Cancer Profiles. } \examples{ \dontrun{ diff --git a/man/demo_food.Rd b/man/demo_food.Rd index ff063f2..924eb3c 100644 --- a/man/demo_food.Rd +++ b/man/demo_food.Rd @@ -9,18 +9,23 @@ demo_food(area, areatype, food, race = NULL) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either "county" or "state"} +\item{areatype}{Either \code{"county"} or \code{"state"}} -\item{food}{Either "food insecurity" or "limited access to healthy food"} +\item{food}{Either \code{"food insecurity"} or \code{"limited access to healthy food"}} -\item{race}{One of the following values: "All Races (includes Hispanic)", "white non hispanic", -"black (includes hispanic)","hispanic (any race)} +\item{race}{One of the following values: +\itemize{ +\item "All Races (includes Hispanic)" +\item "White non-Hispanic" +\item "Black (includes Hispanic)" +\item "Hispanic (Any Race) +}} } \value{ -A data frame with the following columns: Area Type, Area Code, "Value", "People" +A data frame with the following columns: Area Type, Area Code, Value, People" } \description{ -This function returns a data frame from Food Insecurity in State Cancer Profiles +This function returns a data frame about Food Insecurity from State Cancer Profiles. } \examples{ \dontrun{ diff --git a/man/demo_income.Rd b/man/demo_income.Rd index 25de18a..9c1a81d 100644 --- a/man/demo_income.Rd +++ b/man/demo_income.Rd @@ -9,19 +9,26 @@ demo_income(area, areatype, income, race) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either "county" or "state"} +\item{areatype}{Either \code{"county"} or \code{"state"}} -\item{income}{Either "median family income" or "median household income"} +\item{income}{Either \code{"median family income"} or \code{"median household income"}} -\item{race}{One of the following values: "All Races (includes Hispanic)", "white (includes hispanic)", -"white non-hispanic","black","amer. indian/alaskan native (includes hispanic)", -"asian or pacific islander (includes hispanic)","hispanic (any race)} +\item{race}{One of the following values: +\itemize{ +\item "All Races (includes Hispanic)" +\item "White (includes Hispanic)" +\item "White non-Hispanic" +\item "Black" +\item "Amer. Indian/Alaskan Native (includes Hispanic)" +\item "Asian or Pacific Islander (includes Hispanic)" +\item "hispanic (Any Race) +}} } \value{ -A data frame with the following columns: Area Type, Area Code, "Dollars", "Rank" +A data frame with the following columns: Area Type, Area Code, Dollars, Rank } \description{ -This function returns a data frame from Income in State Cancer Profiles +This function returns a data frame about income demographics from State Cancer Profiles. } \examples{ \dontrun{ diff --git a/man/demo_insurance.Rd b/man/demo_insurance.Rd index 496fa57..942c723 100644 --- a/man/demo_insurance.Rd +++ b/man/demo_insurance.Rd @@ -9,29 +9,60 @@ demo_insurance(area, areatype, insurance, sex, age, race = NULL) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either "county", "hsa" (Health service area), or "state"} +\item{areatype}{Either \code{"county"}, \code{"hsa"} (Health Service Area), or +\code{"state"}.} -\item{insurance}{Either -"\% Insured in demographic group, all income levels", "\% Insured in demographic group, people at or below 138\% of Poverty" -"\% Insured in demographic group, people at or below 200\% of Poverty", "\% Insured in demographic group, people at or below 250\% of Poverty" -"\% Insured in demographic group, people at or below 400\% of Poverty","\% Insured in demographic group, people between 138\% - 400\% of poverty" -"\% uninsured in demographic group, all income levels","\% uninsured in demographic group, people at or below 138\% of Poverty" -"\% uninsured in demographic group, people at or below 200\% of Poverty","\% 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"} +\item{insurance}{The only permissible values are: +\itemize{ +\item \code{"\% Insured in demographic group, all income levels"} +\item \code{"\% Insured in demographic group, people at or below 138\% of Poverty"} +\item \code{"\% Insured in demographic group, people at or below 200\% of Poverty"} +\item \code{"\% Insured in demographic group, people at or below 250\% of Poverty"} +\item \code{"\% Insured in demographic group, people at or below 400\% of Poverty"} +\item \code{"\% Insured in demographic group, people between 138\% - 400\% of poverty"} +\item \code{"\% uninsured in demographic group, all income levels"} +\item \code{"\% uninsured in demographic group, people at or below 138\% of Poverty"} +\item \code{"\% uninsured in demographic group, people at or below 200\% of Poverty"} +\item \code{"\% uninsured in demographic group, people at or below 250\% of Poverty"} +\item \code{"\% uninsured in demographic group, people at or below 400\% of Poverty"} +\item \code{"\% uninsured in demographic group, people between 138\% - 400\% of poverty"} +}} \item{sex}{Either "both sexes", "male", "female"} -\item{age}{Either "under 19 years", "18 to 64 years","21 to 64 years","40 to 64 years","50 to 64 years","under 65 years" for "both sexes" -"18 to 64 years","40 to 64 years","50 to 64 years","Under 65 years" for "males" and "females"} +\item{age}{The only permissible values for "both sexes" are: +\itemize{ +\item "under 19 years" +\item "18 to 64 years" +\item "21 to 64 years" +\item "40 to 64 years" +\item "50 to 64 years" +\item "under 65 years" +} + +The only permissible values for "males" and "females" are: +\itemize{ +\item "18 to 64 years" +\item "40 to 64 years" +\item "50 to 64 years" +\item "Under 65 years" +}} -\item{race}{Either "all races (includes hispanic)", "white (non-hispanic)", "black (non-hispanic)", "american indian / alaska native non-hispanic", -"asian (non-hispanic)", "hispanic (any race)"} +\item{race}{One of the following values: +\itemize{ +\item All Races (includes Hispanic)" +\item "White (non-Hispanic)" +\item "black (non-Hispanic)" +\item "American Indian / Alaska Native (non-Hispanic)" +\item "Asian (non-Hispanic)" +\item "Hispanic (Any Race)" +}} } \value{ A data frame with the following columns: Area Type, Area Code, "Percent", "People", "Rank" } \description{ -This function returns a data frame from Insurance in State Cancer Profiles +This function returns a data frame about insurance demographics from State Cancer Profiles. } \examples{ \dontrun{ From 7ac8135b1ea0055577d9fe01cc45e2ad81546f00 Mon Sep 17 00:00:00 2001 From: realbp Date: Wed, 6 Mar 2024 14:56:44 -0800 Subject: [PATCH 2/3] edited all documentation --- R/demo-crowding.R | 20 +++++---- R/demo-education.R | 32 +++++++------- R/demo-food-access.R | 18 ++++---- R/demo-income.R | 20 ++++----- R/demo-insurance.R | 55 +++++++++++++----------- R/demo-mobility.R | 12 +++--- R/demo-non-english-language.R | 10 +++-- R/demo-population.R | 43 +++++++++++++++---- R/demo-poverty.R | 31 +++++++++---- R/demo-svi.R | 11 +++-- R/demo-workforce.R | 28 ++++++++---- R/incidence-cancer.R | 74 ++++++++++++++++++++++++-------- R/mortality-cancer.R | 70 ++++++++++++++++++++++-------- R/risk-alcohol.R | 22 +++++++--- R/risk-colorectal-screening.R | 30 ++++++++----- R/risk-diet-exercise.R | 31 ++++++++----- R/risk-smoking.R | 51 +++++++++++++++------- R/risk-vaccines.R | 16 ++++--- R/risk-womens-health.R | 24 +++++++---- man/demo_crowding.Rd | 22 ++++++---- man/demo_education.Rd | 32 ++++++++------ man/demo_food.Rd | 18 +++++--- man/demo_income.Rd | 16 +++---- man/demo_insurance.Rd | 57 +++++++++++++----------- man/demo_language.Rd | 10 +++-- man/demo_mobility.Rd | 18 +++++--- man/demo_population.Rd | 45 +++++++++++++++---- man/demo_poverty.Rd | 35 +++++++++++---- man/demo_svi.Rd | 11 ++++- man/demo_workforce.Rd | 28 +++++++++--- man/risk_alcohol.Rd | 26 ++++++++--- man/risk_colorectal_screening.Rd | 36 +++++++++++----- man/risk_diet_exercise.Rd | 37 +++++++++++----- man/risk_smoking.Rd | 51 ++++++++++++++++------ man/risk_vaccines.Rd | 18 +++++--- man/risk_women_health.Rd | 30 +++++++++---- 36 files changed, 740 insertions(+), 348 deletions(-) diff --git a/R/demo-crowding.R b/R/demo-crowding.R index b5f34dc..071fdba 100644 --- a/R/demo-crowding.R +++ b/R/demo-crowding.R @@ -4,19 +4,21 @@ #' Cancer Profiles. #' #' @param area A state/territory abbreviation or USA. -#' @param areatype Either `"county"`, `"hsa"` (Health Service Area), or -#' `"state"`. +#' @param areatype One of the following values: +#' - `"county"` +#' - `"hsa"` (Health Service Area) +#' - `"state"`. #' @param crowding The only permissible value is #' `"household with >1 person per room"`. #' @param race #' One of the following values: -#' - "All Races (includes Hispanic)" -#' - "White (includes Hispanic)" -#' - "White Non-Hispanic" -#' - "Black" -#' - "Amer. Indian/Alaskan Native (includes Hispanic)" -#' - "Asian or Pacific Islander (includes Hispanic)" -#' - "Hispanic (Any Race)" +#' - `"All Races (includes Hispanic)"` +#' - `"White (includes Hispanic)"` +#' - `"White Non-Hispanic"` +#' - `"Black"` +#' - `"Amer. Indian/Alaskan Native (includes Hispanic)"` +#' - `"Asian or Pacific Islander (includes Hispanic)"` +#' - `"Hispanic (Any Race)"`. #' #' @importFrom httr2 req_url_query req_perform #' @importFrom stats setNames diff --git a/R/demo-education.R b/R/demo-education.R index 8107e84..c1ae2c0 100644 --- a/R/demo-education.R +++ b/R/demo-education.R @@ -3,30 +3,32 @@ #' This function returns a data frame about education demographics from State Cancer Profiles. #' #' @param area A state/territory abbreviation or USA. -#' @param areatype Either `"county"`, `"hsa"` (Health Service Area), or -#' `"state"`. -#' @param education The only permissible values are +#' @param areatype One of the following values: +#' - `"county"` +#' - `"hsa"` (Health Service Area) +#' - `"state"`. +#' @param education One of the following values: #' - `"less than 9th grade"` #' - `"at least high school"` -#' - `"at least bachelors degree"` +#' - `"at least bachelors degree"`. #' @param sex One of the following values: -#' - "both sexes" -#' - "male" -#' - "female" +#' - `"both sexes"` +#' - `"male"` +#' - `"female"`. #' @param race One of the following values: -#' - "All Races (includes Hispanic)" -#' - "White (includes Hispanic)" -#' - "White non-Hispanic" -#' - "Black" -#' - "Amer. Indian/Alaskan Native (includes Hispanic)" -#' - "Asian or Pacific Islander (includes Hispanic)" -#' - "hispanic (Any Race) +#' - `"All Races (includes Hispanic)"` +#' - `"White (includes Hispanic)"` +#' - `"White non-Hispanic"` +#' - `"Black"` +#' - `"Amer. Indian/Alaskan Native (includes Hispanic)"` +#' - `"Asian or Pacific Islander (includes Hispanic)"` +#' - `"Hispanic (Any Race)`. #' #' @importFrom httr2 req_url_query req_perform #' @importFrom cli cli_abort #' @importFrom stats setNames #' -#' @returns A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank +#' @returns A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank. #' #' @export #' diff --git a/R/demo-food-access.R b/R/demo-food-access.R index dfc01cf..5ea20ce 100644 --- a/R/demo-food-access.R +++ b/R/demo-food-access.R @@ -1,22 +1,24 @@ #' Access to Food Insecurity Data #' -#' This function returns a data frame about Food Insecurity from State Cancer Profiles. +#' This function returns a data frame about food demographics from State Cancer Profiles. #' #' @param area A state/territory abbreviation or USA. -#' @param areatype Either `"county"` or `"state"` -#' @param food Either `"food insecurity"` or `"limited access to healthy food"` +#' @param areatype Either `"county"` or `"state"`. +#' @param food One of the following values: +#' - `"food insecurity"` +#' - `"limited access to healthy food"`. #' @param race One of the following values: -#' - "All Races (includes Hispanic)" -#' - "White non-Hispanic" -#' - "Black (includes Hispanic)" -#' - "Hispanic (Any Race) +#' - `"All Races (includes Hispanic)"` +#' - `"White non-Hispanic"` +#' - `"Black (includes Hispanic)"` +#' - `"Hispanic (Any Race)`. #' #' @importFrom httr2 req_url_query req_perform #' @importFrom cli cli_abort #' @importFrom dplyr mutate #' @importFrom stats setNames #' -#' @returns A data frame with the following columns: Area Type, Area Code, Value, People" +#' @returns A data frame with the following columns: Area Type, Area Code, Value, People". #' #' @export #' diff --git a/R/demo-income.R b/R/demo-income.R index 1720284..44de89b 100644 --- a/R/demo-income.R +++ b/R/demo-income.R @@ -3,23 +3,23 @@ #' This function returns a data frame about income demographics from State Cancer Profiles. #' #' @param area A state/territory abbreviation or USA. -#' @param areatype Either `"county"` or `"state"` -#' @param income Either `"median family income"` or `"median household income"` +#' @param areatype Either `"county"` or `"state"`. +#' @param income Either `"median family income"` or `"median household income"`. #' @param race One of the following values: -#' - "All Races (includes Hispanic)" -#' - "White (includes Hispanic)" -#' - "White non-Hispanic" -#' - "Black" -#' - "Amer. Indian/Alaskan Native (includes Hispanic)" -#' - "Asian or Pacific Islander (includes Hispanic)" -#' - "hispanic (Any Race) +#' - `"All Races (includes Hispanic)"` +#' - `"White (includes Hispanic)"` +#' - `"White non-Hispanic"` +#' - `"Black"` +#' - `"Amer. Indian/Alaskan Native (includes Hispanic)"` +#' - `"Asian or Pacific Islander (includes Hispanic)"` +#' - `"Hispanic (Any Race)`. #' #' @importFrom httr2 req_url_query req_perform #' @importFrom cli cli_abort #' @importFrom dplyr mutate #' @importFrom stats setNames #' -#' @returns A data frame with the following columns: Area Type, Area Code, Dollars, Rank +#' @returns A data frame with the following columns: Area Type, Area Code, Dollars, Rank. #' #' @export #' diff --git a/R/demo-insurance.R b/R/demo-insurance.R index 7af0bc1..61d84c8 100644 --- a/R/demo-insurance.R +++ b/R/demo-insurance.R @@ -3,9 +3,11 @@ #' This function returns a data frame about insurance demographics from State Cancer Profiles. #' #' @param area A state/territory abbreviation or USA. -#' @param areatype Either `"county"`, `"hsa"` (Health Service Area), or -#' `"state"`. -#' @param insurance The only permissible values are: +#' @param areatype One of the following values: +#' - `"county"` +#' - `"hsa"` (Health Service Area) +#' - `"state"`. +#' @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"` #' - `"% Insured in demographic group, people at or below 200% of Poverty"` @@ -17,33 +19,36 @@ #' - `"% uninsured in demographic group, people at or below 200% of Poverty"` #' - `"% 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 Either "both sexes", "male", "female" -#' @param age The only permissible values for "both sexes" are: -#' - "under 19 years" -#' - "18 to 64 years" -#' - "21 to 64 years" -#' - "40 to 64 years" -#' - "50 to 64 years" -#' - "under 65 years" +#' - `"% uninsured in demographic group, people between 138% - 400% of poverty"`. +#' @param sex One of the following values: +#' - `"both sexes"` +#' - `"male"` +#' - `"female"`. +#' @param age If you specified `"both sexes"` for `sex` choose one of the following values: +#' - `"under 19 years"` +#' - `"18 to 64 years"` +#' - `"21 to 64 years"` +#' - `"40 to 64 years"` +#' - `"50 to 64 years"` +#' - `"under 65 years"`. #' -#' The only permissible values for "males" and "females" are: -#' - "18 to 64 years" -#' - "40 to 64 years" -#' - "50 to 64 years" -#' - "Under 65 years" -#' @param race One of the following values: -#' - All Races (includes Hispanic)" -#' - "White (non-Hispanic)" -#' - "black (non-Hispanic)" -#' - "American Indian / Alaska Native (non-Hispanic)" -#' - "Asian (non-Hispanic)" -#' - "Hispanic (Any Race)" +#' Otherwise if you specified `"male"` or `"female"` for `sex`, choose one of the following values: +#' - `"18 to 64 years"` +#' - `"40 to 64 years"` +#' - `"50 to 64 years"` +#' - `"Under 65 years"`. +#' @param race Only specify `race` if you specified `"state"` for `areatype` +#' - `"All Races (includes Hispanic)"` +#' - `"White (non-Hispanic)"` +#' - `"black (non-Hispanic)"` +#' - `"American Indian / Alaska Native (non-Hispanic)"` +#' - `"Asian (non-Hispanic)"` +#' - `"Hispanic (Any Race)"`. #' #' @importFrom httr2 req_url_query req_perform #' @importFrom cli cli_abort #' -#' @returns A data frame with the following columns: Area Type, Area Code, "Percent", "People", "Rank" +#' @returns A data frame with the following columns: Area Type, Area Code, Percent, People, Rank. #' #' @export #' diff --git a/R/demo-mobility.R b/R/demo-mobility.R index 4dc1733..ccbb119 100644 --- a/R/demo-mobility.R +++ b/R/demo-mobility.R @@ -3,20 +3,22 @@ #' This function returns a data frame about mobility demographics from State Cancer Profiles. #' #' @param area A state/territory abbreviation or USA. -#' @param areatype Either `"county"`, `"hsa"` (Health Service Area), or -#' `"state"`. +#' @param areatype One of the following values: +#' - `"county"` +#' - `"hsa"` (Health Service Area) +#' - `"state"`. #' @param mobility The only permissible values are -#' -` "i haven't moved (in past year)"` +#' - `"i haven't moved (in past year)"` #' - `"moved from outside us (in past year)"` #' - `"moved, different state (in past year)"` #' - `"moved, different county, same state (in past year)"` -#' - `"moved, same county (in past year)"` +#' - `"moved, same county (in past year)"`. #' #' @importFrom httr2 req_url_query req_perform #' @importFrom cli cli_abort #' @importFrom stats setNames #' -#' @returns A data frame with the following columns: Area Type, Area Code, Percent, People, Rank +#' @returns A data frame with the following columns: Area Type, Area Code, Percent, People, Rank. #' #' @export #' diff --git a/R/demo-non-english-language.R b/R/demo-non-english-language.R index eb91dec..1170db0 100644 --- a/R/demo-non-english-language.R +++ b/R/demo-non-english-language.R @@ -3,15 +3,17 @@ #' This function returns a data frame about language demographics from State Cancer Profiles. #' #' @param area A state/territory abbreviation or USA. -#' @param areatype Either `"county"`, `"hsa"` (Health Service Area), or -#' `"state"`. +#' @param areatype One of the following values: +#' - `"county"` +#' - `"hsa"` (Health Service Area) +#' - `"state"`. #' @param language The only permissible value is -#' `"language isolation"` +#' `"language isolation"`. #' #' @importFrom httr2 req_url_query req_perform #' @importFrom stats setNames #' -#' @returns A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank +#' @returns A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank. #' #' @export #' diff --git a/R/demo-population.R b/R/demo-population.R index 3fbfc5a..81d96e3 100644 --- a/R/demo-population.R +++ b/R/demo-population.R @@ -1,21 +1,46 @@ #' Access to Population Data #' -#' This function returns a data frame from population in State Cancer Profiles +#' This function returns a data frame from population in State Cancer Profiles. #' #' @param area A state/territory abbreviation or USA. -#' @param areatype Either "county", "hsa" (Health service area), or "state" -#' @param population One of the following values: "age under 18", "age 18-39", "age 40-64", "ages 40 and over", "ages 50 and over", "ages 60 and over", -#' "american indian/alaska native", "asian/pacific islander", "black", "foreign born", "hispanic", -#' "non-hispanic (origin recode)", "white", "males", "females" -#' @param race One of the following values: "american indian/alaska native", "asian/pacific islander", -#' "black", "hispanic", "white (includes hispanic)", "white non-hispanic", "hispanic (any race)" -#' @param sex Either "both sexes", "males", "females" +#' @param areatype One of the following values: +#' - `"county"` +#' - `"hsa"` (Health Service Area) +#' - `"state"`. +#' @param population One of the following values: +#' - `"age under 18"` +#' - `"age 18-39"` +#' - `"age 40-64"` +#' - `"ages 40 and over"` +#' - `"ages 50 and over"` +#' - `"ages 60 and over"` +#' - `"american indian/alaska native"` +#' - `"asian/pacific islander"` +#' - `"black"` +#' - `"foreign born"` +#' - `"hispanic"` +#' - `"non-hispanic (origin recode)"` +#' - `"white"` +#' - `"males"` +#' - `"females"`. +#' @param race One of the following values: +#' - `"American Indian/Alaska Native"` +#' - `"Asian/Pacific Islander"` +#' - `"Black"` +#' - `"Hispanic"` +#' - `"White (includes Hispanic)"` +#' - `"White non-Hispanic"` +#' - `"Hispanic (Any Race)"`. +#' @param sex One of the following values: +#' - `"both sexes"` +#' - `"male"` +#' - `"female"`. #' #' @importFrom httr2 req_url_query req_perform #' @importFrom cli cli_abort #' @importFrom stats setNames #' -#' @returns A data frame with the following columns: Area Type, Area Code, "Percent", "Households", "Rank" +#' @returns A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank. #' #' @export #' diff --git a/R/demo-poverty.R b/R/demo-poverty.R index 77939b2..333fe37 100644 --- a/R/demo-poverty.R +++ b/R/demo-poverty.R @@ -1,19 +1,34 @@ #' Access to Poverty Data #' -#' This function returns a data frame from Poverty in State Cancer Profiles +#' This function returns a data frame about poverty demographics from State Cancer Profiles. #' #' @param area A state/territory abbreviation or USA. -#' @param areatype Either "county", "hsa" (Health service area), or "state" -#' @param poverty Either "families below poverty", "persistent poverty", "persons below poverty", "persons < 150% of poverty" -#' @param race One of the following values: "All Races (includes Hispanic)", "white (includes hispanic)", -#' "white non-hispanic","black","amer. indian/alaskan native (includes hispanic)", -#' "asian or pacific islander (includes hispanic)","hispanic (any race) -#' @param sex Either "both sexes", "male", "female" +#' @param areatype One of the following values: +#' - `"county"` +#' - `"hsa"` (Health Service Area) +#' - `"state"`. +#' @param poverty One of the following values: +#' - `"families below poverty"` +#' - `"persistent poverty"` +#' - `"persons below poverty"` +#' - `"persons < 150% of poverty"`. +#' @param race One of the following values: +#' - `"All Races (includes Hispanic)"` +#' - `"White (includes Hispanic)"` +#' - `"White non-Hispanic"` +#' - `"Black"` +#' - `"Amer. Indian/Alaskan Native (includes Hispanic)"` +#' - `"Asian or Pacific Islander (includes Hispanic)"` +#' - `"Hispanic (Any Race)`. +#' @param sex One of the following values +#' - `"both sexes"` +#' - `"male"` +#' - `"female"`. #' #' @importFrom httr2 req_url_query req_perform #' @importFrom stats setNames #' -#' @returns A data frame with the following columns: Area Type, Area Code, "Percent", "Households", "Rank" +#' @returns A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank. #' #' @export #' diff --git a/R/demo-svi.R b/R/demo-svi.R index 79821cd..411744a 100644 --- a/R/demo-svi.R +++ b/R/demo-svi.R @@ -1,14 +1,19 @@ #' Access to Social Vulnerability Index (SVI) Data #' -#' This function returns a data frame from Social Vulnerability Index (SVI) in State Cancer Profiles +#' This function returns a data frame from social vulnerability index (SVI) in State Cancer Profiles. #' #' @param area A state/territory abbreviation or USA. -#' @param svi Either "Overall", "socioeconomic status", "household characteristics", "racial & ethinic minority status", "housing type & transportation" +#' @param svi One of the following values: +#' - `"Overall"` +#' - `"socioeconomic status"` +#' - `"household characteristics"` +#' - `"racial & ethinic minority status"` +#' - `"housing type & transportation"`. #' #' @importFrom httr2 req_url_query req_perform #' @importFrom stats setNames #' -#' @returns A data frame with the following columns "County", "FIPS", "Score" +#' @returns A data frame with the following columns County, FIPS, Score. #' #' @export #' diff --git a/R/demo-workforce.R b/R/demo-workforce.R index 95a733e..d2ee228 100644 --- a/R/demo-workforce.R +++ b/R/demo-workforce.R @@ -1,19 +1,31 @@ #' Access to Workforce Data #' -#' This function returns a data frame from Workforce in State Cancer Profiles +#' This function returns a data frame from Workforce in State Cancer Profiles. #' #' @param area A state/territory abbreviation or USA. -#' @param areatype Either "county", "hsa" (Health service area), or "state" -#' @param workforce "unemployed" -#' @param race One of the following values: "All Races (includes Hispanic)", "white (includes hispanic)" = "01", -#' "white non-hispanic","black","amer. indian/alaskan native (includes hispanic)", -#' "asian or pacific islander (includes hispanic)","hispanic (any race) -#' @param sex Either "both sexes", "male", "female" +#' @param areatype One of the following values: +#' - `"county"` +#' - `"hsa"` (Health Service Area) +#' - `"state"`. +#' @param workforce The only permissible value is + #' `"unemployed"` +#' @param race One of the following values: +#' - `"All Races (includes Hispanic)"` +#' - `"White (includes Hispanic)"` +#' - `"White non-Hispanic"` +#' - `"Black"` +#' - `"Amer. Indian/Alaskan Native (includes Hispanic)"` +#' - `"Asian or Pacific Islander (includes Hispanic)"` +#' - `"Hispanic (Any Race)`. +#' @param sex One of the following values: +#' - `"both sexes"` +#' - `"male"` +#' - `"female"`. #' #' @importFrom httr2 req_url_query req_perform #' @importFrom stats setNames #' -#' @returns A data frame with the following columns: Area Type, Area Code, "Percent", "People Unemployed", "Rank" +#' @returns A data frame with the following columns: Area Type, Area Code, Percent, People Unemployed, Rank. #' #' @export #' diff --git a/R/incidence-cancer.R b/R/incidence-cancer.R index 5c95249..9465a13 100644 --- a/R/incidence-cancer.R +++ b/R/incidence-cancer.R @@ -1,25 +1,65 @@ #' Access to Cancer Incident Data #' -#' This function returns a data frame from Cancer Incident in State Cancer Profiles +#' This function returns a data frame about cancer incidence from State Cancer Profiles. #' #' @param area A state/territory abbreviation or USA. -#' @param areatype Either "county", "hsa" (Health service area), or "state" -#' @param cancer Either "all cancer sites","bladder", "brain & ons", "breast (female)", "breast (female in situ)", "cervix", -#' "childhood (ages <15, all sites)", "childhood (ages <20, all sites)", "colon & rectum", "esophagus", -#' "kidney & renal pelvis", "leukemia", "liver & bile duct", "lung & bronchus", "melanoma of the skin", -#' "non-hodgkin lymphoma", "oral cavity & pharynx", "ovary", "pancreas", "prostate", "stomach", -#' "thyroid", "uterus (corpus & uterus, nos)" -#' @param race One of the following values: "all races (includes hispanic)", "white (non-hispanic)", -#' "black (non-hispanic)", "amer. indian / ak native (non-hispanic)", -#' "asian / pacific islander (non-hispanic)","hispanic (any race)" -#' @param sex Either "both sexes", "males", "females" -#' @param age Either "all ages", "ages <50", "ages 50+", "ages <65", "ages 65+", ages <15, ages <20 -#' @param stage Either "all stages" or "late stage (regional & distant)" -#' @param year Either "latest 5 year average", "latest single year (us by state)" +#' @param areatype One of the following values: +#' - `"county"` +#' - `"hsa"` (Health Service Area) +#' - `"state"`. +#' @param cancer One of the following values: +#' - `"all cancer sites"` +#' - `"bladder"` +#' - `"brain & ons"` +#' - `"breast (female)"` +#' - `"breast (female in situ)"` +#' - `"cervix"` +#' - `"childhood (ages <15, all sites)"` +#' - `"childhood (ages <20, all sites)"` +#' - `"colon & rectum"` +#' - `"esophagus"` +#' - `"kidney & renal pelvis"` +#' - `"leukemia"` +#' - `"liver & bile duct"` +#' - `"lung & bronchus"` +#' - `"melanoma of the skin"` +#' - `"non-hodgkin lymphoma"` +#' - `"oral cavity & pharynx"` +#' - `"ovary"` +#' - `"pancreas"` +#' - `"prostate"` +#' - `"stomach"` +#' - `"thyroid"` +#' - `"uterus (corpus & uterus, nos)"`. +#' @param race One of the following values: +#' - `"All Races (includes Hispanic)"` +#' - `"White (non-Hispanic)"` +#' - `"Black (non-Hispanic)"` +#' - `"American Indian / Alaska Native (non-Hispanic)"` +#' - `"Asian / Pacific Islander (non-Hispanic)"` +#' - `"Hispanic (Any Race)"`. +#' @param sex One of the following values: +#' - `"both sexes"` +#' - `"male"` +#' - `"female"`. +#' @param age One of the following values: +#' - `"all ages"` +#' - `"ages <50"` +#' - `"ages 50+"` +#' - `"ages <65"` +#' - `"ages 65+"` +#' - `"ages <15"` +#' - `"ages <20"`. +#' @param stage One of the following values: +#' - `"all stages"` +#' - `"late stage (regional & distant)"`. +#' @param year One of the following values: +#' - `"latest 5 year average"` +#' - `"latest single year (us by state)"`. #' -#' @returns A data frame with the following columns: Area Type, Area Code, "Age Adjusted Incidence Rate", "Lower 95% CI", -#' "Upper 95% CI", "CI Rank", "Lower CI Rank", "Upper CI Rank", "Annual Average Count", "Recent Trend", -#' "Recent 5 Year Trend", "Trend Lower 95% CI", "Trend Upper 95% CI" +#' @returns A data frame with the following columns: Area Type, Area Code, Age Adjusted Incidence Rate, Lower 95% CI, +#' Upper 95% CI, CI Rank, Lower CI Rank, Upper CI Rank, Annual Average Count, Recent Trend, +#' Recent 5 Year Trend, Trend Lower 95% CI, Trend Upper 95% CI. #' #' @export #' diff --git a/R/mortality-cancer.R b/R/mortality-cancer.R index 768f1ef..a3328c6 100644 --- a/R/mortality-cancer.R +++ b/R/mortality-cancer.R @@ -1,25 +1,61 @@ #' Access to Cancer Mortality Data #' -#' This function returns a data frame from Cancer Mortality in State Cancer Profiles +#' This function returns a data frame about cancer mortality from State Cancer Profiles. #' #' @param area A state/territory abbreviation or USA. -#' @param areatype Either "county", "hsa" (Health service area), or "state" -#' @param cancer Either "all cancer sites","bladder", "brain & ons", "breast (female)", "cervix", -#' "childhood (ages <15, all sites)", "childhood (ages <20, all sites)", "colon & rectum", "esophagus", -#' "kidney & renal pelvis", "leukemia", "liver & bile duct", "lung & bronchus", "melanoma of the skin", -#' "non-hodgkin lymphoma", "oral cavity & pharynx", "ovary", "pancreas", "prostate", "stomach", -#' "thyroid", "uterus (corpus & uterus, nos)" -#' @param race One of the following values: "all races (includes hispanic)", "white (non-hispanic)", -#' "black (non-hispanic)", "amer. indian / ak native (non-hispanic)", -#' "asian / pacific islander (non-hispanic)","hispanic (any race)" -#' @param sex Defaulted to NULL. Specify either "both sexes", "males", "females" if necessary -#' @param age Either "all ages", "ages <50", "ages 50+", "ages <65", "ages 65+", ages <15, ages <20 -#' @param year Either "latest 5 year average", "latest single year (us by state)" +#' @param areatype One of the following values: +#' - `"county"` +#' - `"hsa"` (Health Service Area) +#' - `"state"`. +#' @param cancer One of the following values: +#' `"all cancer sites"` +#' `"bladder", "brain & ons"` +#' `"breast (female)"` +#' `"cervix"` +#' `"childhood (ages <15, all sites)"` +#' `"childhood (ages <20, all sites)"` +#' `"colon & rectum"` +#' `"esophagus"` +#' `"kidney & renal pelvis"` +#' `"leukemia"` +#' `"liver & bile duct"` +#' `"lung & bronchus"` +#' `"melanoma of the skin"` +#' `"non-hodgkin lymphoma"` +#' `"oral cavity & pharynx"` +#' `"ovary"` +#' `"pancreas"` +#' `"prostate"` +#' `"stomach"` +#' `"thyroid"` +#' `"uterus (corpus & uterus, nos)"` +#' @param race One of the following values: +#' - `"All Races (includes Hispanic)"` +#' - `"White (non-Hispanic)"` +#' - `"Black (non-Hispanic)"` +#' - `"American Indian / Alaska Native (non-Hispanic)"` +#' - `"Asian / Pacific Islander (non-Hispanic)"` +#' - `"Hispanic (Any Race)"`. +#' @param sex One of the following values: +#' - `"both sexes"` +#' - `"male"` +#' - `"female"`. +#' @param age One of the following values: +#' - `"all ages"` +#' - `"ages <50"` +#' - `"ages 50+"` +#' - `"ages <65"` +#' - `"ages 65+"` +#' - `"ages <15"` +#' - `"ages <20"`. +#' @param year One of the following values: +#' - `"latest 5 year average"` +#' - `"latest single year (us by state)"`. #' -#' @returns A data frame with the following columns: Area Type, Area Code, "Met Healthy People Objective of ***?", -#' "Age Adjusted Death Rate", "Lower 95% CI Rate", "Upper 95% CI Rate", -#' "CI Rank", "Lower CI Rank", "Upper CI Rank", "Annual Average Count", -#' "Recent Trend", "Recent 5 Year Trend", "Lower 95% CI Trend", "Upper 95% CI Trend" +#' @returns A data frame with the following columns: Area Type, Area Code, Met Healthy People Objective of ***?, +#' Age Adjusted Death Rate, Lower 95% CI Rate, Upper 95% CI Rate, +#' CI Rank, Lower CI Rank, Upper CI Rank, Annual Average Count, +#' Recent Trend, Recent 5 Year Trend, Lower 95% CI Trend, Upper 95% CI Trend. #' #' @export #' diff --git a/R/risk-alcohol.R b/R/risk-alcohol.R index 803e146..d48e709 100644 --- a/R/risk-alcohol.R +++ b/R/risk-alcohol.R @@ -1,14 +1,22 @@ #' Access to Alcohol Screening and Risk Data #' -#' This function returns a data frame from Alcohol in State Cancer Profiles +#' This function returns a data frame about alcohol risks from State Cancer Profiles. #' -#' @param alcohol "binge drinking (4+ drinks on one occasion for women, 5+ drinks for one occasion for men), ages 21+" -#' @param race One of the following values: "All Races (includes Hispanic)", "white (includes hispanic)" = "01", -#' "white non-hispanic","black","amer. indian/alaskan native (includes hispanic)", -#' "asian or pacific islander (includes hispanic)","hispanic (any race) -#' @param sex Either "both sexes", "male", "female" +#' @param alcohol The only permissible value is +#' `"binge drinking (4+ drinks on one occasion for women, 5+ drinks for one occasion for men), ages 21+"`. +#' @param race One of the following values: +#' - `"All Races (includes Hispanic)"` +#' - `"White (non-Hispanic)"` +#' - `"Black (non-Hispanic)"` +#' - `"American Indian / Alaska Native (non-Hispanic)"` +#' - `"Asian / Pacific Islander (non-Hispanic)"` +#' - `"Hispanic (Any Race)"`. +#' @param sex One of the following values: +#' - `"both sexes"` +#' - `"male"` +#' - `"female"`. #' -#' @returns A data frame with the following columns: Area Type, Area Code, "Percent", "Lower 95% CI", "Upper 95% CI", "Number of Respondents" +#' @returns A data frame with the following columns: Area Type, Area Code, Percent, Lower 95% CI, Upper 95% CI, Number of Respondents. #' #' @export #' diff --git a/R/risk-colorectal-screening.R b/R/risk-colorectal-screening.R index b2a7db6..9a2d328 100644 --- a/R/risk-colorectal-screening.R +++ b/R/risk-colorectal-screening.R @@ -1,19 +1,27 @@ #' Access to Colorectal Screening Data #' -#' This function returns a data frame from Colorectal Screening in State Cancer Profiles +#' This function returns a data frame about colorectal screening from State Cancer Profiles. #' -#' @param screening One of the following values: "ever had fobt, ages 50-75", -#' "guidance sufficient crc, ages 50-75", -#' "had colonoscopy in past 10 years, ages 50-75" -#' "home blood stool test in the past year, ages 45-75" -#' "received at least one recommended crc test, ages 45-75" -#' @param race One of the following values: "All Races (includes Hispanic)", "white (includes hispanic)", -#' "white non-hispanic","black","amer. indian/alaskan native (includes hispanic)", -#' "asian or pacific islander (includes hispanic)","hispanic (any race) -#' @param sex Either "both sexes", "male", "female" +#' @param screening One of the following values: +#' - `"ever had fobt, ages 50-75"` +#' - `"guidance sufficient crc, ages 50-75"` +#' - `"had colonoscopy in past 10 years, ages 50-75"` +#' - `"home blood stool test in the past year, ages 45-75"` +#' - `"received at least one recommended crc test, ages 45-75"`. +#' @param race One of the following values: +#' - `"All Races (includes Hispanic)"` +#' - `"White (non-Hispanic)"` +#' - `"Black (non-Hispanic)"` +#' - `"American Indian / Alaska Native (non-Hispanic)"` +#' - `"Asian / Pacific Islander (non-Hispanic)"` +#' - `"Hispanic (Any Race)"`. +#' @param sex One of the following values: +#' - `"both sexes"` +#' - `"male"` +#' - `"female"`. #' @param area A state/territory abbreviation or USA. #' -#' @returns A data frame with the following columns: Area Type, Area Code, "Percent", "People Unemployed", "Rank" +#' @returns A data frame with the following columns: Area Type, Area Code, Percent, People Unemployed, Rank. #' #' @export #' diff --git a/R/risk-diet-exercise.R b/R/risk-diet-exercise.R index 743ff53..71af815 100644 --- a/R/risk-diet-exercise.R +++ b/R/risk-diet-exercise.R @@ -1,17 +1,28 @@ #' Access to Diet & Exercise Screening Data #' -#' This function returns a data frame from Diet & Exercise in State Cancer Profiles +#' This function returns a data frame about diet and exercise risk from State Cancer Profiles. #' -#' @param diet_exercise Either "bmi is healthy, ages 20+", "bmi is obese, ages 20+", -#' "bmi is obese, high school survey", "bmi is overweight, high school survey", -#' "consumed 1 or more fruits per day", "consumed 1 or more vegetables per day", -#' "no leisure time physical activity" -#' @param race One of the following values: "All Races (includes Hispanic)", "white (includes hispanic)" = "01", -#' "white non-hispanic","black","amer. indian/alaskan native (includes hispanic)", -#' "asian or pacific islander (includes hispanic)","hispanic (any race) -#' @param sex Either "both sexes", "male", "female" +#' @param diet_exercise One of the following values: +#' - `"bmi is healthy, ages 20+"` +#' - `"bmi is obese, ages 20+"` +#' - `"bmi is obese, high school survey"` +#' - `"bmi is overweight, high school survey"` +#' - `"consumed 1 or more fruits per day"` +#' - `"consumed 1 or more vegetables per day"` +#' - `"no leisure time physical activity"`. +#' @param race One of the following values: +#' - `"All Races (includes Hispanic)"` +#' - `"White (non-Hispanic)"` +#' - `"Black (non-Hispanic)"` +#' - `"American Indian / Alaska Native (non-Hispanic)"` +#' - `"Asian / Pacific Islander (non-Hispanic)"` +#' - `"Hispanic (Any Race)"`. +#' @param sex One of the following values: +#' - `"both sexes"` +#' - `"male"` +#' - `"female"`. #' -#' @returns A data frame with the following columns: Area Type, Area Code, "Percent", "Lower 95% CI", "Upper 95% CI", "Number of Respondents" +#' @returns A data frame with the following columns: Area Type, Area Code, Percent, Lower 95% CI, Upper 95% CI, Number of Respondents. #' #' @export #' diff --git a/R/risk-smoking.R b/R/risk-smoking.R index 474efad..e8e1d22 100644 --- a/R/risk-smoking.R +++ b/R/risk-smoking.R @@ -1,29 +1,48 @@ #' Access to Smoking Data #' -#' This function returns a data frame from Smoking in State Cancer Profiles +#' This function returns a data frame about smoking risks from State Cancer Profiles. #' -#' Please note that this function requires very specific arguments for each smoking type +#' Please note that this function requires very specific arguments for each smoking type. #' -#' @param smoking Either "smoking laws (any)", "smoking laws (bars)", "smoking laws (restaurants)", -#' "smoking laws (workplace)", "smoking laws (workplace; restaurant; & bar)", -#' "smokers (stopped for 1 day or longer)", "smoking not allowed at work (all people)", -#' "smoking not allowed in home (all people)", "smoking not allowed at work (current smokers)", -#' "smoking not allowed at work (former/never smokers)", "smoking not allowed in home (current smokers)", -#' "smoking not allowed in home (former/never smokers)", "former smoker; ages 18+", -#' "former smoker, quit 1 year+; ages 18+", "smokers (ever); ages 18+", "e-cigarette use; ages 18+", -#' "smokers (current); ages 18+" -#' @param race One of the following values: "all races (includes hispanic)", "white (non-hispanic)", -#' "black (non-hispanic)", "amer. indian / ak native (non-hispanic)", -#' "asian / pacific islander (non-hispanic)","hispanic (any race)" -#' @param sex Either "both sexes", "males", "females" -#' @param datatype Either "direct estimates" or "county level modeled estimates" +#' @param smoking The only permissible values are +#' - `"smoking laws (any)"` +#' - `"smoking laws (bars)"` +#' - `"smoking laws (restaurants)"` +#' - `"smoking laws (workplace)"` +#' - `"smoking laws (workplace; restaurant; & bar)"` +#' - `"smokers (stopped for 1 day or longer)"` +#' - `"smoking not allowed at work (all people)"` +#' - `"smoking not allowed in home (all people)"` +#' - `"smoking not allowed at work (current smokers)"` +#' - `"smoking not allowed at work (former/never smokers)"` +#' - `"smoking not allowed in home (current smokers)"` +#' - `"smoking not allowed in home (former/never smokers)"` +#' - `"former smoker; ages 18+"` +#' - `"former smoker, quit 1 year+; ages 18+"` +#' - `"smokers (ever); ages 18+"` +#' - `"e-cigarette use; ages 18+"` +#' - `"smokers (current); ages 18+"`. +#' @param race One of the following values: +#' - `"All Races (includes Hispanic)"` +#' - `"White (non-Hispanic)"` +#' - `"Black (non-Hispanic)"` +#' - `"American Indian / Alaska Native (non-Hispanic)"` +#' - `"Asian / Pacific Islander (non-Hispanic)"` +#' - `"Hispanic (Any Race)"`. +#' @param sex One of the following values +#' - `"both sexes"` +#' - `"male"` +#' - `"female"`. +#' @param datatype One of the following values: +#' - `"direct estimates"` +#' - `"county level modeled estimates"`. #' @param area A state/territory abbreviation or USA. #' #' @importFrom httr2 req_url_query req_perform #' @importFrom cli cli_abort #' @importFrom stats setNames #' -#' @returns A data frame with the following columns: Area Type, Area Code, "Percent", "Lower CI 95%", "Upper CI 95%", "Number of Respondents" +#' @returns A data frame with the following columns: Area Type, Area Code, Percent, Lower CI 95%, Upper CI 95%, Number of Respondents. #' #' @export #' diff --git a/R/risk-vaccines.R b/R/risk-vaccines.R index 3e47357..3ba4495 100644 --- a/R/risk-vaccines.R +++ b/R/risk-vaccines.R @@ -1,12 +1,16 @@ #' Access to Vaccines Data #' -#' This function returns a data frame from Vaccines in State Cancer Profiles +#' This function returns a data frame about vaccines risks from State Cancer Profiles. #' -#' @param vaccine Either "percent with up to date hpv vaccination coverage, ages 13-15", -#' "percent with up to date hpv vaccination coverage, ages 13-17" -#' @param sex Either "both sexes", "males", "females" -#' -#' @returns A data frame with the following columns: Area Type, Area Code, "Percent", "Lower 95% CI", "Upper 95% CI", "Number of Respondents" +#' @param vaccine One of the following values: +#' - `"percent with up to date hpv vaccination coverage, ages 13-15",` +#' - `"percent with up to date hpv vaccination coverage, ages 13-17"`. +#' @param sex One of the following values: +#' - `"both sexes"` +#' - `"male"` +#' - `"female"`. +#' +#' @returns A data frame with the following columns: Area Type, Area Code, Percent, Lower 95% CI, Upper 95% CI, Number of Respondents. #' #' @export #' diff --git a/R/risk-womens-health.R b/R/risk-womens-health.R index f436167..1ad28f3 100644 --- a/R/risk-womens-health.R +++ b/R/risk-womens-health.R @@ -1,16 +1,24 @@ #' Access to Women's Health Data #' -#' This function returns a data frame from Women's Health in State Cancer Profiles +#' This function returns a data frame about women's health risks from State Cancer Profiles. #' -#' @param women_health Either "mammogram in past 2 years, ages 50-74", "mammogram in past 2 years, ages 40+", -#' "pap smear in past 3 years, no hysterectomy, ages 21-65" -#' @param race One of the following values: "all races (includes hispanic)", "white (non-hispanic)", -#' "black (non-hispanic)", "amer. indian / ak native (non-hispanic)", -#' "asian / pacific islander (non-hispanic)","hispanic (any race)" -#' @param datatype Either "direct estimates" or "county level modeled estimates" +#' @param women_health One of the following values: +#' - `"mammogram in past 2 years, ages 50-74"` +#' - `"mammogram in past 2 years, ages 40+"` +#' - `"pap smear in past 3 years, no hysterectomy, ages 21-65"`. +#' @param race One of the following values +#' - `"All Races (includes Hispanic)"` +#' - `"White (non-Hispanic)"` +#' - `"Black (non-Hispanic)"` +#' - `"American Indian / Alaska Native (non-Hispanic)"` +#' - `"Asian / Pacific Islander (non-Hispanic)"` +#' - `"Hispanic (Any Race)"`. +#' @param datatype One of the following values: +#' - `"direct estimates"` +#' - `"county level modeled estimates"`. #' @param area A state/territory abbreviation or USA. #' -#' @returns A data frame with the following columns: Area Type, Area Code, "Percent", "People Unemployed", "Rank" +#' @returns A data frame with the following columns: Area Type, Area Code, Percent, People Unemployed, Rank. #' #' @export #' diff --git a/man/demo_crowding.Rd b/man/demo_crowding.Rd index a7245c8..8071747 100644 --- a/man/demo_crowding.Rd +++ b/man/demo_crowding.Rd @@ -14,21 +14,25 @@ demo_crowding( \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either \code{"county"}, \code{"hsa"} (Health Service Area), or -\code{"state"}.} +\item{areatype}{One of the following values +\itemize{ +\item \code{"county"} +\item \code{"hsa"} (Health Service Area) +\item \code{"state"} +}} \item{crowding}{The only permissible value is \code{"household with >1 person per room"}.} \item{race}{One of the following values: \itemize{ -\item "All Races (includes Hispanic)" -\item "White (includes Hispanic)" -\item "White Non-Hispanic" -\item "Black" -\item "Amer. Indian/Alaskan Native (includes Hispanic)" -\item "Asian or Pacific Islander (includes Hispanic)" -\item "Hispanic (Any Race)" +\item \code{"All Races (includes Hispanic)"} +\item \code{"White (includes Hispanic)"} +\item \code{"White Non-Hispanic"} +\item \code{"Black"} +\item \code{"Amer. Indian/Alaskan Native (includes Hispanic)"} +\item \code{"Asian or Pacific Islander (includes Hispanic)"} +\item \code{"Hispanic (Any Race)"} }} } \value{ diff --git a/man/demo_education.Rd b/man/demo_education.Rd index d720b13..deb8983 100644 --- a/man/demo_education.Rd +++ b/man/demo_education.Rd @@ -9,10 +9,14 @@ demo_education(area, areatype, education, sex = NULL, race = NULL) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either \code{"county"}, \code{"hsa"} (Health Service Area), or -\code{"state"}.} +\item{areatype}{One of the following values +\itemize{ +\item \code{"county"} +\item \code{"hsa"} (Health Service Area) +\item \code{"state"} +}} -\item{education}{The only permissible values are +\item{education}{One of the following values: \itemize{ \item \code{"less than 9th grade"} \item \code{"at least high school"} @@ -21,24 +25,24 @@ demo_education(area, areatype, education, sex = NULL, race = NULL) \item{sex}{One of the following values: \itemize{ -\item "both sexes" -\item "male" -\item "female" +\item \code{"both sexes"} +\item \code{"male"} +\item \code{"female"} }} \item{race}{One of the following values: \itemize{ -\item "All Races (includes Hispanic)" -\item "White (includes Hispanic)" -\item "White non-Hispanic" -\item "Black" -\item "Amer. Indian/Alaskan Native (includes Hispanic)" -\item "Asian or Pacific Islander (includes Hispanic)" -\item "hispanic (Any Race) +\item \code{"All Races (includes Hispanic)"} +\item \code{"White (includes Hispanic)"} +\item \code{"White non-Hispanic"} +\item \code{"Black"} +\item \code{"Amer. Indian/Alaskan Native (includes Hispanic)"} +\item \code{"Asian or Pacific Islander (includes Hispanic)"} +\item \verb{"Hispanic (Any Race)} }} } \value{ -A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank +A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank. } \description{ This function returns a data frame about education demographics from State Cancer Profiles. diff --git a/man/demo_food.Rd b/man/demo_food.Rd index 924eb3c..4d419f1 100644 --- a/man/demo_food.Rd +++ b/man/demo_food.Rd @@ -11,21 +11,25 @@ demo_food(area, areatype, food, race = NULL) \item{areatype}{Either \code{"county"} or \code{"state"}} -\item{food}{Either \code{"food insecurity"} or \code{"limited access to healthy food"}} +\item{food}{One of the following values: +\itemize{ +\item \code{"food insecurity"} +\item \code{"limited access to healthy food"} +}} \item{race}{One of the following values: \itemize{ -\item "All Races (includes Hispanic)" -\item "White non-Hispanic" -\item "Black (includes Hispanic)" -\item "Hispanic (Any Race) +\item \code{"All Races (includes Hispanic)"} +\item \code{"White non-Hispanic"} +\item \code{"Black (includes Hispanic)"} +\item \verb{"Hispanic (Any Race)} }} } \value{ -A data frame with the following columns: Area Type, Area Code, Value, People" +A data frame with the following columns: Area Type, Area Code, Value, People". } \description{ -This function returns a data frame about Food Insecurity from State Cancer Profiles. +This function returns a data frame about food demographics from State Cancer Profiles. } \examples{ \dontrun{ diff --git a/man/demo_income.Rd b/man/demo_income.Rd index 9c1a81d..8f26350 100644 --- a/man/demo_income.Rd +++ b/man/demo_income.Rd @@ -15,17 +15,17 @@ demo_income(area, areatype, income, race) \item{race}{One of the following values: \itemize{ -\item "All Races (includes Hispanic)" -\item "White (includes Hispanic)" -\item "White non-Hispanic" -\item "Black" -\item "Amer. Indian/Alaskan Native (includes Hispanic)" -\item "Asian or Pacific Islander (includes Hispanic)" -\item "hispanic (Any Race) +\item \code{"All Races (includes Hispanic)"} +\item \code{"White (includes Hispanic)"} +\item \code{"White non-Hispanic"} +\item \code{"Black"} +\item \code{"Amer. Indian/Alaskan Native (includes Hispanic)"} +\item \code{"Asian or Pacific Islander (includes Hispanic)"} +\item \verb{"Hispanic (Any Race)} }} } \value{ -A data frame with the following columns: Area Type, Area Code, Dollars, Rank +A data frame with the following columns: Area Type, Area Code, Dollars, Rank. } \description{ This function returns a data frame about income demographics from State Cancer Profiles. diff --git a/man/demo_insurance.Rd b/man/demo_insurance.Rd index 942c723..f0ba30e 100644 --- a/man/demo_insurance.Rd +++ b/man/demo_insurance.Rd @@ -9,10 +9,14 @@ demo_insurance(area, areatype, insurance, sex, age, race = NULL) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either \code{"county"}, \code{"hsa"} (Health Service Area), or -\code{"state"}.} +\item{areatype}{One of the following values +\itemize{ +\item \code{"county"} +\item \code{"hsa"} (Health Service Area) +\item \code{"state"} +}} -\item{insurance}{The only permissible values are: +\item{insurance}{One of the following values: \itemize{ \item \code{"\% Insured in demographic group, all income levels"} \item \code{"\% Insured in demographic group, people at or below 138\% of Poverty"} @@ -28,38 +32,43 @@ demo_insurance(area, areatype, insurance, sex, age, race = NULL) \item \code{"\% uninsured in demographic group, people between 138\% - 400\% of poverty"} }} -\item{sex}{Either "both sexes", "male", "female"} +\item{sex}{One of the following values: +\itemize{ +\item \code{"both sexes"} +\item \code{"male"} +\item \code{"female"} +}} -\item{age}{The only permissible values for "both sexes" are: +\item{age}{If you specified \code{"both sexes"} for \code{sex} choose one of the following values: \itemize{ -\item "under 19 years" -\item "18 to 64 years" -\item "21 to 64 years" -\item "40 to 64 years" -\item "50 to 64 years" -\item "under 65 years" +\item \code{"under 19 years"} +\item \code{"18 to 64 years"} +\item \code{"21 to 64 years"} +\item \code{"40 to 64 years"} +\item \code{"50 to 64 years"} +\item \code{"under 65 years"} } -The only permissible values for "males" and "females" are: +Otherwise if you specified \code{"male"} or \code{"female"} for \code{sex}, choose one of the following values: \itemize{ -\item "18 to 64 years" -\item "40 to 64 years" -\item "50 to 64 years" -\item "Under 65 years" +\item \code{"18 to 64 years"} +\item \code{"40 to 64 years"} +\item \code{"50 to 64 years"} +\item \code{"Under 65 years"} }} -\item{race}{One of the following values: +\item{race}{Only specify \code{race} if you specified \code{"state"} for \code{areatype} \itemize{ -\item All Races (includes Hispanic)" -\item "White (non-Hispanic)" -\item "black (non-Hispanic)" -\item "American Indian / Alaska Native (non-Hispanic)" -\item "Asian (non-Hispanic)" -\item "Hispanic (Any Race)" +\item \code{"All Races (includes Hispanic)"} +\item \code{"White (non-Hispanic)"} +\item \code{"black (non-Hispanic)"} +\item \code{"American Indian / Alaska Native (non-Hispanic)"} +\item \code{"Asian (non-Hispanic)"} +\item \code{"Hispanic (Any Race)"} }} } \value{ -A data frame with the following columns: Area Type, Area Code, "Percent", "People", "Rank" +A data frame with the following columns: Area Type, Area Code, Percent, People, Rank. } \description{ This function returns a data frame about insurance demographics from State Cancer Profiles. diff --git a/man/demo_language.Rd b/man/demo_language.Rd index 11ded96..4964666 100644 --- a/man/demo_language.Rd +++ b/man/demo_language.Rd @@ -9,15 +9,17 @@ demo_language(area, areatype, language) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either "county", "hsa" (Health service area), or "state"} +\item{areatype}{Either \code{"county"}, \code{"hsa"} (Health Service Area), or +\code{"state"}.} -\item{language}{"language isolation"} +\item{language}{The only permissible value is +\code{"language isolation"}} } \value{ -A data frame with the following columns: Area Type, Area Code, "Percent", "Households", "Rank" +A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank } \description{ -This function returns a data frame from Crowding in State Cancer Profiles +This function returns a data frame about language demographics from State Cancer Profiles. } \examples{ demo_language(area = "WA", diff --git a/man/demo_mobility.Rd b/man/demo_mobility.Rd index 4ab25e3..b636855 100644 --- a/man/demo_mobility.Rd +++ b/man/demo_mobility.Rd @@ -9,17 +9,23 @@ demo_mobility(area, areatype, mobility) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either "county", "hsa" (Health service area), or "state"} +\item{areatype}{Either \code{"county"}, \code{"hsa"} (Health Service Area), or +\code{"state"}.} -\item{mobility}{One of five choices from "i haven't moved (in past year)", "moved from outside us (in past year)", -"moved, different state (in past year)", "moved, different county, same state (in past year)", -"moved, same county (in past year)"} +\item{mobility}{The only permissible values are +-\code{ "i haven't moved (in past year)"} +\itemize{ +\item \code{"moved from outside us (in past year)"} +\item \code{"moved, different state (in past year)"} +\item \code{"moved, different county, same state (in past year)"} +\item \code{"moved, same county (in past year)"} +}} } \value{ -A data frame with the following columns: Area Type, Area Code, "Percent", "People", "Rank" +A data frame with the following columns: Area Type, Area Code, Percent, People, Rank } \description{ -This function returns a data frame from mobility in State Cancer Profiles +This function returns a data frame about mobility demographics from State Cancer Profiles. } \examples{ \dontrun{ diff --git a/man/demo_population.Rd b/man/demo_population.Rd index e6072d4..bb4081e 100644 --- a/man/demo_population.Rd +++ b/man/demo_population.Rd @@ -9,19 +9,48 @@ demo_population(area, areatype, population, race = NULL, sex = NULL) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either "county", "hsa" (Health service area), or "state"} +\item{areatype}{Either \code{"county"}, \code{"hsa"} (Health Service Area), or +\code{"state"}.} -\item{population}{One of the following values: "age under 18", "age 18-39", "age 40-64", "ages 40 and over", "ages 50 and over", "ages 60 and over", -"american indian/alaska native", "asian/pacific islander", "black", "foreign born", "hispanic", -"non-hispanic (origin recode)", "white", "males", "females"} +\item{population}{The only permissible values are +\itemize{ +\item \code{"age under 18"} +\item \code{"age 18-39"} +\item \code{"age 40-64"} +\item \code{"ages 40 and over"} +\item \code{"ages 50 and over"} +\item \code{"ages 60 and over"} +\item \code{"american indian/alaska native"} +\item \code{"asian/pacific islander"} +\item \code{"black"} +\item \code{"foreign born"} +\item \code{"hispanic"} +\item \code{"non-hispanic (origin recode)"} +\item \code{"white"} +\item \code{"males"} +\item \code{"females"} +}} -\item{race}{One of the following values: "american indian/alaska native", "asian/pacific islander", -"black", "hispanic", "white (includes hispanic)", "white non-hispanic", "hispanic (any race)"} +\item{race}{One of the following values +\itemize{ +\item "American Indian/Alaska Native" +\item "Asian/Pacific Islander" +\item "Black" +\item "Hispanic" +\item "White (includes Hispanic)" +\item "White non-Hispanic" +\item "Hispanic (Any Race)" +}} -\item{sex}{Either "both sexes", "males", "females"} +\item{sex}{One of the following values +\itemize{ +\item "both sexes" +\item "male" +\item "female" +}} } \value{ -A data frame with the following columns: Area Type, Area Code, "Percent", "Households", "Rank" +A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank } \description{ This function returns a data frame from population in State Cancer Profiles diff --git a/man/demo_poverty.Rd b/man/demo_poverty.Rd index c7bf63d..c37d568 100644 --- a/man/demo_poverty.Rd +++ b/man/demo_poverty.Rd @@ -9,21 +9,40 @@ demo_poverty(area, areatype, poverty, race = NULL, sex = NULL) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either "county", "hsa" (Health service area), or "state"} +\item{areatype}{Either \code{"county"}, \code{"hsa"} (Health Service Area), or +\code{"state"}.} -\item{poverty}{Either "families below poverty", "persistent poverty", "persons below poverty", "persons < 150\% of poverty"} +\item{poverty}{The only permissible values are +\itemize{ +\item \code{"families below poverty"} +\item \code{"persistent poverty"} +\item \code{"persons below poverty"} +\item \code{"persons < 150\% of poverty"} +}} -\item{race}{One of the following values: "All Races (includes Hispanic)", "white (includes hispanic)", -"white non-hispanic","black","amer. indian/alaskan native (includes hispanic)", -"asian or pacific islander (includes hispanic)","hispanic (any race)} +\item{race}{One of the following values +\itemize{ +\item "All Races (includes Hispanic)" +\item "White (includes Hispanic)" +\item "White non-Hispanic" +\item "Black" +\item "Amer. Indian/Alaskan Native (includes Hispanic)" +\item "Asian or Pacific Islander (includes Hispanic)" +\item "hispanic (Any Race) +}} -\item{sex}{Either "both sexes", "male", "female"} +\item{sex}{One of the following values +\itemize{ +\item "both sexes" +\item "male" +\item "female" +}} } \value{ -A data frame with the following columns: Area Type, Area Code, "Percent", "Households", "Rank" +A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank } \description{ -This function returns a data frame from Poverty in State Cancer Profiles +This function returns a data frame about poverty demographics from State Cancer Profiles. } \examples{ \dontrun{ diff --git a/man/demo_svi.Rd b/man/demo_svi.Rd index 42c58e4..2fecb16 100644 --- a/man/demo_svi.Rd +++ b/man/demo_svi.Rd @@ -9,10 +9,17 @@ demo_svi(area, svi) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{svi}{Either "Overall", "socioeconomic status", "household characteristics", "racial & ethinic minority status", "housing type & transportation"} +\item{svi}{The only permissible values are +\itemize{ +\item \code{"Overall"} +\item \code{"socioeconomic status"} +\item \code{"household characteristics"} +\item \code{"racial & ethinic minority status"} +\item \code{"housing type & transportation"} +}} } \value{ -A data frame with the following columns "County", "FIPS", "Score" +A data frame with the following columns County, FIPS, Score } \description{ This function returns a data frame from Social Vulnerability Index (SVI) in State Cancer Profiles diff --git a/man/demo_workforce.Rd b/man/demo_workforce.Rd index 1ed5c08..2b97052 100644 --- a/man/demo_workforce.Rd +++ b/man/demo_workforce.Rd @@ -9,18 +9,32 @@ demo_workforce(area, areatype, workforce, race, sex) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either "county", "hsa" (Health service area), or "state"} +\item{areatype}{Either \code{"county"}, \code{"hsa"} (Health Service Area), or +\code{"state"}.} -\item{workforce}{"unemployed"} +\item{workforce}{The only permissible values are +\code{"unemployed"}} -\item{race}{One of the following values: "All Races (includes Hispanic)", "white (includes hispanic)" = "01", -"white non-hispanic","black","amer. indian/alaskan native (includes hispanic)", -"asian or pacific islander (includes hispanic)","hispanic (any race)} +\item{race}{One of the following values +\itemize{ +\item "All Races (includes Hispanic)" +\item "White (includes Hispanic)" +\item "White non-Hispanic" +\item "Black" +\item "Amer. Indian/Alaskan Native (includes Hispanic)" +\item "Asian or Pacific Islander (includes Hispanic)" +\item "hispanic (Any Race) +}} -\item{sex}{Either "both sexes", "male", "female"} +\item{sex}{One of the following values +\itemize{ +\item "both sexes" +\item "male" +\item "female" +}} } \value{ -A data frame with the following columns: Area Type, Area Code, "Percent", "People Unemployed", "Rank" +A data frame with the following columns: Area Type, Area Code, Percent, People Unemployed, Rank } \description{ This function returns a data frame from Workforce in State Cancer Profiles diff --git a/man/risk_alcohol.Rd b/man/risk_alcohol.Rd index 22fb985..0c3967a 100644 --- a/man/risk_alcohol.Rd +++ b/man/risk_alcohol.Rd @@ -7,19 +7,31 @@ risk_alcohol(alcohol, race, sex) } \arguments{ -\item{alcohol}{"binge drinking (4+ drinks on one occasion for women, 5+ drinks for one occasion for men), ages 21+"} +\item{alcohol}{The only permissible value is +\code{"binge drinking (4+ drinks on one occasion for women, 5+ drinks for one occasion for men), ages 21+"}} -\item{race}{One of the following values: "All Races (includes Hispanic)", "white (includes hispanic)" = "01", -"white non-hispanic","black","amer. indian/alaskan native (includes hispanic)", -"asian or pacific islander (includes hispanic)","hispanic (any race)} +\item{race}{One of the following values: +\itemize{ +\item "All Races (includes Hispanic)" +\item "White (non-Hispanic)" +\item "Black (non-Hispanic)" +\item "American Indian / Alaska Native (non-Hispanic)" +\item "Asian / Pacific Islander (non-Hispanic)" +\item "Hispanic (Any Race)" +}} -\item{sex}{Either "both sexes", "male", "female"} +\item{sex}{One of the following values +\itemize{ +\item "both sexes" +\item "male" +\item "female" +}} } \value{ -A data frame with the following columns: Area Type, Area Code, "Percent", "Lower 95\% CI", "Upper 95\% CI", "Number of Respondents" +A data frame with the following columns: Area Type, Area Code, Percent, Lower 95\% CI, Upper 95\% CI, Number of Respondents } \description{ -This function returns a data frame from Alcohol in State Cancer Profiles +This function returns a data frame about alcohol risks from State Cancer Profiles. } \examples{ \dontrun{ diff --git a/man/risk_colorectal_screening.Rd b/man/risk_colorectal_screening.Rd index 43c59f8..cfc4113 100644 --- a/man/risk_colorectal_screening.Rd +++ b/man/risk_colorectal_screening.Rd @@ -7,25 +7,39 @@ risk_colorectal_screening(screening, race = NULL, sex = NULL, area = NULL) } \arguments{ -\item{screening}{One of the following values: "ever had fobt, ages 50-75", -"guidance sufficient crc, ages 50-75", -"had colonoscopy in past 10 years, ages 50-75" -"home blood stool test in the past year, ages 45-75" -"received at least one recommended crc test, ages 45-75"} +\item{screening}{The only permissible values are +\itemize{ +\item \code{"ever had fobt, ages 50-75"} +\item \code{"guidance sufficient crc, ages 50-75"} +\item \code{"had colonoscopy in past 10 years, ages 50-75"} +\item \code{"home blood stool test in the past year, ages 45-75"} +\item \code{"received at least one recommended crc test, ages 45-75"} +}} -\item{race}{One of the following values: "All Races (includes Hispanic)", "white (includes hispanic)", -"white non-hispanic","black","amer. indian/alaskan native (includes hispanic)", -"asian or pacific islander (includes hispanic)","hispanic (any race)} +\item{race}{One of the following values: +\itemize{ +\item "All Races (includes Hispanic)" +\item "White (non-Hispanic)" +\item "Black (non-Hispanic)" +\item "American Indian / Alaska Native (non-Hispanic)" +\item "Asian / Pacific Islander (non-Hispanic)" +\item "Hispanic (Any Race)" +}} -\item{sex}{Either "both sexes", "male", "female"} +\item{sex}{One of the following values +\itemize{ +\item "both sexes" +\item "male" +\item "female" +}} \item{area}{A state/territory abbreviation or USA.} } \value{ -A data frame with the following columns: Area Type, Area Code, "Percent", "People Unemployed", "Rank" +A data frame with the following columns: Area Type, Area Code, Percent, People Unemployed, Rank } \description{ -This function returns a data frame from Colorectal Screening in State Cancer Profiles +This function returns a data frame about Colorectal Screening from State Cancer Profiles. } \examples{ \dontrun{ diff --git a/man/risk_diet_exercise.Rd b/man/risk_diet_exercise.Rd index fd36d76..20b2569 100644 --- a/man/risk_diet_exercise.Rd +++ b/man/risk_diet_exercise.Rd @@ -7,22 +7,39 @@ risk_diet_exercise(diet_exercise, race, sex) } \arguments{ -\item{diet_exercise}{Either "bmi is healthy, ages 20+", "bmi is obese, ages 20+", -"bmi is obese, high school survey", "bmi is overweight, high school survey", -"consumed 1 or more fruits per day", "consumed 1 or more vegetables per day", -"no leisure time physical activity"} +\item{diet_exercise}{The only permissible values are +\itemize{ +\item \code{"bmi is healthy, ages 20+"} +\item \code{"bmi is obese, ages 20+"} +\item \code{"bmi is obese, high school survey"} +\item \code{"bmi is overweight, high school survey"} +\item \code{"consumed 1 or more fruits per day"} +\item \code{"consumed 1 or more vegetables per day"} +\item \code{"no leisure time physical activity"} +}} -\item{race}{One of the following values: "All Races (includes Hispanic)", "white (includes hispanic)" = "01", -"white non-hispanic","black","amer. indian/alaskan native (includes hispanic)", -"asian or pacific islander (includes hispanic)","hispanic (any race)} +\item{race}{One of the following values: +\itemize{ +\item "All Races (includes Hispanic)" +\item "White (non-Hispanic)" +\item "Black (non-Hispanic)" +\item "American Indian / Alaska Native (non-Hispanic)" +\item "Asian / Pacific Islander (non-Hispanic)" +\item "Hispanic (Any Race)" +}} -\item{sex}{Either "both sexes", "male", "female"} +\item{sex}{One of the following values +\itemize{ +\item "both sexes" +\item "male" +\item "female" +}} } \value{ -A data frame with the following columns: Area Type, Area Code, "Percent", "Lower 95\% CI", "Upper 95\% CI", "Number of Respondents" +A data frame with the following columns: Area Type, Area Code, Percent, Lower 95\% CI, Upper 95\% CI, Number of Respondents } \description{ -This function returns a data frame from Diet & Exercise in State Cancer Profiles +This function returns a data frame about Diet & Exercise risk from State Cancer Profiles. } \examples{ \dontrun{ diff --git a/man/risk_smoking.Rd b/man/risk_smoking.Rd index ef69be5..53d9667 100644 --- a/man/risk_smoking.Rd +++ b/man/risk_smoking.Rd @@ -7,30 +7,53 @@ risk_smoking(smoking, race = NULL, sex = NULL, datatype = NULL, area = NULL) } \arguments{ -\item{smoking}{Either "smoking laws (any)", "smoking laws (bars)", "smoking laws (restaurants)", -"smoking laws (workplace)", "smoking laws (workplace; restaurant; & bar)", -"smokers (stopped for 1 day or longer)", "smoking not allowed at work (all people)", -"smoking not allowed in home (all people)", "smoking not allowed at work (current smokers)", -"smoking not allowed at work (former/never smokers)", "smoking not allowed in home (current smokers)", -"smoking not allowed in home (former/never smokers)", "former smoker; ages 18+", -"former smoker, quit 1 year+; ages 18+", "smokers (ever); ages 18+", "e-cigarette use; ages 18+", -"smokers (current); ages 18+"} +\item{smoking}{The only permissible values are +\itemize{ +\item \code{"smoking laws (any)"} +\item \code{"smoking laws (bars)"} +\item \code{"smoking laws (restaurants)"} +\item \code{"smoking laws (workplace)"} +\item \code{"smoking laws (workplace; restaurant; & bar)"} +\item \code{"smokers (stopped for 1 day or longer)"} +\item \code{"smoking not allowed at work (all people)"} +\item \code{"smoking not allowed in home (all people)"} +\item \code{"smoking not allowed at work (current smokers)"} +\item \code{"smoking not allowed at work (former/never smokers)"} +\item \code{"smoking not allowed in home (current smokers)"} +\item \code{"smoking not allowed in home (former/never smokers)"} +\item \code{"former smoker; ages 18+"} +\item \code{"former smoker, quit 1 year+; ages 18+"} +\item \code{"smokers (ever); ages 18+"} +\item \code{"e-cigarette use; ages 18+"} +\item \code{"smokers (current); ages 18+"} +}} -\item{race}{One of the following values: "all races (includes hispanic)", "white (non-hispanic)", -"black (non-hispanic)", "amer. indian / ak native (non-hispanic)", -"asian / pacific islander (non-hispanic)","hispanic (any race)"} +\item{race}{One of the following values: +\itemize{ +\item "All Races (includes Hispanic)" +\item "White (non-Hispanic)" +\item "Black (non-Hispanic)" +\item "American Indian / Alaska Native (non-Hispanic)" +\item "Asian / Pacific Islander (non-Hispanic)" +\item "Hispanic (Any Race)" +}} -\item{sex}{Either "both sexes", "males", "females"} +\item{sex}{One of the following values +\itemize{ +\item "both sexes" +\item "male" +\item "female" +}} \item{datatype}{Either "direct estimates" or "county level modeled estimates"} \item{area}{A state/territory abbreviation or USA.} } \value{ -A data frame with the following columns: Area Type, Area Code, "Percent", "Lower CI 95\%", "Upper CI 95\%", "Number of Respondents" +A data frame with the following columns: Area Type, Area Code, Percent, Lower CI 95\%, Upper CI 95\%, Number of Respondents } \description{ -This function returns a data frame from Smoking in State Cancer Profiles +This function returns a data frame about Smoking risks from State Cancer Profiles. } \details{ Please note that this function requires very specific arguments for each smoking type diff --git a/man/risk_vaccines.Rd b/man/risk_vaccines.Rd index 4f18141..8062b82 100644 --- a/man/risk_vaccines.Rd +++ b/man/risk_vaccines.Rd @@ -7,16 +7,24 @@ risk_vaccines(vaccine, sex) } \arguments{ -\item{vaccine}{Either "percent with up to date hpv vaccination coverage, ages 13-15", -"percent with up to date hpv vaccination coverage, ages 13-17"} +\item{vaccine}{One of the following values +\itemize{ +\item \verb{"percent with up to date hpv vaccination coverage, ages 13-15",} +\item \code{"percent with up to date hpv vaccination coverage, ages 13-17"} +}} -\item{sex}{Either "both sexes", "males", "females"} +\item{sex}{One of the following values +\itemize{ +\item "both sexes" +\item "male" +\item "female" +}} } \value{ -A data frame with the following columns: Area Type, Area Code, "Percent", "Lower 95\% CI", "Upper 95\% CI", "Number of Respondents" +A data frame with the following columns: Area Type, Area Code, Percent, Lower 95\% CI, Upper 95\% CI, Number of Respondents } \description{ -This function returns a data frame from Vaccines in State Cancer Profiles +This function returns a data frame about vaccines risks from State Cancer Profiles. } \examples{ \dontrun{ diff --git a/man/risk_women_health.Rd b/man/risk_women_health.Rd index 086cc88..8029bb1 100644 --- a/man/risk_women_health.Rd +++ b/man/risk_women_health.Rd @@ -12,22 +12,36 @@ risk_women_health( ) } \arguments{ -\item{women_health}{Either "mammogram in past 2 years, ages 50-74", "mammogram in past 2 years, ages 40+", -"pap smear in past 3 years, no hysterectomy, ages 21-65"} +\item{women_health}{One of the following values +\itemize{ +\item \code{"mammogram in past 2 years, ages 50-74"} +\item \code{"mammogram in past 2 years, ages 40+"} +\item \code{"pap smear in past 3 years, no hysterectomy, ages 21-65"} +}} -\item{race}{One of the following values: "all races (includes hispanic)", "white (non-hispanic)", -"black (non-hispanic)", "amer. indian / ak native (non-hispanic)", -"asian / pacific islander (non-hispanic)","hispanic (any race)"} +\item{race}{One of the following values +\itemize{ +\item "All Races (includes Hispanic)" +\item "White (non-Hispanic)" +\item "Black (non-Hispanic)" +\item "American Indian / Alaska Native (non-Hispanic)" +\item "Asian / Pacific Islander (non-Hispanic)" +\item "Hispanic (Any Race)" +}} -\item{datatype}{Either "direct estimates" or "county level modeled estimates"} +\item{datatype}{One of the following values +\itemize{ +\item \code{"direct estimates"} +\item \code{"county level modeled estimates"} +}} \item{area}{A state/territory abbreviation or USA.} } \value{ -A data frame with the following columns: Area Type, Area Code, "Percent", "People Unemployed", "Rank" +A data frame with the following columns: Area Type, Area Code, Percent, People Unemployed, Rank } \description{ -This function returns a data frame from Women's Health in State Cancer Profiles +This function returns a data frame about women's health risks from State Cancer Profiles. } \examples{ \dontrun{ From 4c174550c8180ff96ab9059dfb7a92a66dde86c0 Mon Sep 17 00:00:00 2001 From: realbp Date: Wed, 6 Mar 2024 15:02:41 -0800 Subject: [PATCH 3/3] triple zeros --- man/demo_crowding.Rd | 6 +-- man/demo_education.Rd | 10 ++-- man/demo_food.Rd | 6 +-- man/demo_income.Rd | 6 +-- man/demo_insurance.Rd | 14 ++--- man/demo_language.Rd | 12 +++-- man/demo_mobility.Rd | 14 +++-- man/demo_population.Rd | 40 ++++++++------- man/demo_poverty.Rd | 36 +++++++------ man/demo_svi.Rd | 8 +-- man/demo_workforce.Rd | 38 ++++++++------ man/incidence_cancer.Rd | 88 ++++++++++++++++++++++++++------ man/mortality_cancer.Rd | 80 +++++++++++++++++++++++------ man/risk_alcohol.Rd | 24 ++++----- man/risk_colorectal_screening.Rd | 28 +++++----- man/risk_diet_exercise.Rd | 28 +++++----- man/risk_smoking.Rd | 32 +++++++----- man/risk_vaccines.Rd | 14 ++--- man/risk_women_health.Rd | 22 ++++---- 19 files changed, 315 insertions(+), 191 deletions(-) diff --git a/man/demo_crowding.Rd b/man/demo_crowding.Rd index 8071747..4cba156 100644 --- a/man/demo_crowding.Rd +++ b/man/demo_crowding.Rd @@ -14,11 +14,11 @@ demo_crowding( \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{One of the following values +\item{areatype}{One of the following values: \itemize{ \item \code{"county"} \item \code{"hsa"} (Health Service Area) -\item \code{"state"} +\item \code{"state"}. }} \item{crowding}{The only permissible value is @@ -32,7 +32,7 @@ demo_crowding( \item \code{"Black"} \item \code{"Amer. Indian/Alaskan Native (includes Hispanic)"} \item \code{"Asian or Pacific Islander (includes Hispanic)"} -\item \code{"Hispanic (Any Race)"} +\item \code{"Hispanic (Any Race)"}. }} } \value{ diff --git a/man/demo_education.Rd b/man/demo_education.Rd index deb8983..d290ee7 100644 --- a/man/demo_education.Rd +++ b/man/demo_education.Rd @@ -9,25 +9,25 @@ demo_education(area, areatype, education, sex = NULL, race = NULL) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{One of the following values +\item{areatype}{One of the following values: \itemize{ \item \code{"county"} \item \code{"hsa"} (Health Service Area) -\item \code{"state"} +\item \code{"state"}. }} \item{education}{One of the following values: \itemize{ \item \code{"less than 9th grade"} \item \code{"at least high school"} -\item \code{"at least bachelors degree"} +\item \code{"at least bachelors degree"}. }} \item{sex}{One of the following values: \itemize{ \item \code{"both sexes"} \item \code{"male"} -\item \code{"female"} +\item \code{"female"}. }} \item{race}{One of the following values: @@ -38,7 +38,7 @@ demo_education(area, areatype, education, sex = NULL, race = NULL) \item \code{"Black"} \item \code{"Amer. Indian/Alaskan Native (includes Hispanic)"} \item \code{"Asian or Pacific Islander (includes Hispanic)"} -\item \verb{"Hispanic (Any Race)} +\item \verb{"Hispanic (Any Race)}. }} } \value{ diff --git a/man/demo_food.Rd b/man/demo_food.Rd index 4d419f1..4fdc53c 100644 --- a/man/demo_food.Rd +++ b/man/demo_food.Rd @@ -9,12 +9,12 @@ demo_food(area, areatype, food, race = NULL) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either \code{"county"} or \code{"state"}} +\item{areatype}{Either \code{"county"} or \code{"state"}.} \item{food}{One of the following values: \itemize{ \item \code{"food insecurity"} -\item \code{"limited access to healthy food"} +\item \code{"limited access to healthy food"}. }} \item{race}{One of the following values: @@ -22,7 +22,7 @@ demo_food(area, areatype, food, race = NULL) \item \code{"All Races (includes Hispanic)"} \item \code{"White non-Hispanic"} \item \code{"Black (includes Hispanic)"} -\item \verb{"Hispanic (Any Race)} +\item \verb{"Hispanic (Any Race)}. }} } \value{ diff --git a/man/demo_income.Rd b/man/demo_income.Rd index 8f26350..75ecaa6 100644 --- a/man/demo_income.Rd +++ b/man/demo_income.Rd @@ -9,9 +9,9 @@ demo_income(area, areatype, income, race) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either \code{"county"} or \code{"state"}} +\item{areatype}{Either \code{"county"} or \code{"state"}.} -\item{income}{Either \code{"median family income"} or \code{"median household income"}} +\item{income}{Either \code{"median family income"} or \code{"median household income"}.} \item{race}{One of the following values: \itemize{ @@ -21,7 +21,7 @@ demo_income(area, areatype, income, race) \item \code{"Black"} \item \code{"Amer. Indian/Alaskan Native (includes Hispanic)"} \item \code{"Asian or Pacific Islander (includes Hispanic)"} -\item \verb{"Hispanic (Any Race)} +\item \verb{"Hispanic (Any Race)}. }} } \value{ diff --git a/man/demo_insurance.Rd b/man/demo_insurance.Rd index f0ba30e..2ef8181 100644 --- a/man/demo_insurance.Rd +++ b/man/demo_insurance.Rd @@ -9,11 +9,11 @@ demo_insurance(area, areatype, insurance, sex, age, race = NULL) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{One of the following values +\item{areatype}{One of the following values: \itemize{ \item \code{"county"} \item \code{"hsa"} (Health Service Area) -\item \code{"state"} +\item \code{"state"}. }} \item{insurance}{One of the following values: @@ -29,14 +29,14 @@ demo_insurance(area, areatype, insurance, sex, age, race = NULL) \item \code{"\% uninsured in demographic group, people at or below 200\% of Poverty"} \item \code{"\% uninsured in demographic group, people at or below 250\% of Poverty"} \item \code{"\% uninsured in demographic group, people at or below 400\% of Poverty"} -\item \code{"\% uninsured in demographic group, people between 138\% - 400\% of poverty"} +\item \code{"\% uninsured in demographic group, people between 138\% - 400\% of poverty"}. }} \item{sex}{One of the following values: \itemize{ \item \code{"both sexes"} \item \code{"male"} -\item \code{"female"} +\item \code{"female"}. }} \item{age}{If you specified \code{"both sexes"} for \code{sex} choose one of the following values: @@ -46,7 +46,7 @@ demo_insurance(area, areatype, insurance, sex, age, race = NULL) \item \code{"21 to 64 years"} \item \code{"40 to 64 years"} \item \code{"50 to 64 years"} -\item \code{"under 65 years"} +\item \code{"under 65 years"}. } Otherwise if you specified \code{"male"} or \code{"female"} for \code{sex}, choose one of the following values: @@ -54,7 +54,7 @@ Otherwise if you specified \code{"male"} or \code{"female"} for \code{sex}, choo \item \code{"18 to 64 years"} \item \code{"40 to 64 years"} \item \code{"50 to 64 years"} -\item \code{"Under 65 years"} +\item \code{"Under 65 years"}. }} \item{race}{Only specify \code{race} if you specified \code{"state"} for \code{areatype} @@ -64,7 +64,7 @@ Otherwise if you specified \code{"male"} or \code{"female"} for \code{sex}, choo \item \code{"black (non-Hispanic)"} \item \code{"American Indian / Alaska Native (non-Hispanic)"} \item \code{"Asian (non-Hispanic)"} -\item \code{"Hispanic (Any Race)"} +\item \code{"Hispanic (Any Race)"}. }} } \value{ diff --git a/man/demo_language.Rd b/man/demo_language.Rd index 4964666..c8623f8 100644 --- a/man/demo_language.Rd +++ b/man/demo_language.Rd @@ -9,14 +9,18 @@ demo_language(area, areatype, language) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either \code{"county"}, \code{"hsa"} (Health Service Area), or -\code{"state"}.} +\item{areatype}{One of the following values: +\itemize{ +\item \code{"county"} +\item \code{"hsa"} (Health Service Area) +\item \code{"state"}. +}} \item{language}{The only permissible value is -\code{"language isolation"}} +\code{"language isolation"}.} } \value{ -A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank +A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank. } \description{ This function returns a data frame about language demographics from State Cancer Profiles. diff --git a/man/demo_mobility.Rd b/man/demo_mobility.Rd index b636855..121e70c 100644 --- a/man/demo_mobility.Rd +++ b/man/demo_mobility.Rd @@ -9,20 +9,24 @@ demo_mobility(area, areatype, mobility) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either \code{"county"}, \code{"hsa"} (Health Service Area), or -\code{"state"}.} +\item{areatype}{One of the following values: +\itemize{ +\item \code{"county"} +\item \code{"hsa"} (Health Service Area) +\item \code{"state"}. +}} \item{mobility}{The only permissible values are --\code{ "i haven't moved (in past year)"} \itemize{ +\item \code{"i haven't moved (in past year)"} \item \code{"moved from outside us (in past year)"} \item \code{"moved, different state (in past year)"} \item \code{"moved, different county, same state (in past year)"} -\item \code{"moved, same county (in past year)"} +\item \code{"moved, same county (in past year)"}. }} } \value{ -A data frame with the following columns: Area Type, Area Code, Percent, People, Rank +A data frame with the following columns: Area Type, Area Code, Percent, People, Rank. } \description{ This function returns a data frame about mobility demographics from State Cancer Profiles. diff --git a/man/demo_population.Rd b/man/demo_population.Rd index bb4081e..ffd7864 100644 --- a/man/demo_population.Rd +++ b/man/demo_population.Rd @@ -9,10 +9,14 @@ demo_population(area, areatype, population, race = NULL, sex = NULL) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either \code{"county"}, \code{"hsa"} (Health Service Area), or -\code{"state"}.} +\item{areatype}{One of the following values: +\itemize{ +\item \code{"county"} +\item \code{"hsa"} (Health Service Area) +\item \code{"state"}. +}} -\item{population}{The only permissible values are +\item{population}{One of the following values: \itemize{ \item \code{"age under 18"} \item \code{"age 18-39"} @@ -28,32 +32,32 @@ demo_population(area, areatype, population, race = NULL, sex = NULL) \item \code{"non-hispanic (origin recode)"} \item \code{"white"} \item \code{"males"} -\item \code{"females"} +\item \code{"females"}. }} -\item{race}{One of the following values +\item{race}{One of the following values: \itemize{ -\item "American Indian/Alaska Native" -\item "Asian/Pacific Islander" -\item "Black" -\item "Hispanic" -\item "White (includes Hispanic)" -\item "White non-Hispanic" -\item "Hispanic (Any Race)" +\item \code{"American Indian/Alaska Native"} +\item \code{"Asian/Pacific Islander"} +\item \code{"Black"} +\item \code{"Hispanic"} +\item \code{"White (includes Hispanic)"} +\item \code{"White non-Hispanic"} +\item \code{"Hispanic (Any Race)"}. }} -\item{sex}{One of the following values +\item{sex}{One of the following values: \itemize{ -\item "both sexes" -\item "male" -\item "female" +\item \code{"both sexes"} +\item \code{"male"} +\item \code{"female"}. }} } \value{ -A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank +A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank. } \description{ -This function returns a data frame from population in State Cancer Profiles +This function returns a data frame from population in State Cancer Profiles. } \examples{ \dontrun{ diff --git a/man/demo_poverty.Rd b/man/demo_poverty.Rd index c37d568..73d581e 100644 --- a/man/demo_poverty.Rd +++ b/man/demo_poverty.Rd @@ -9,37 +9,41 @@ demo_poverty(area, areatype, poverty, race = NULL, sex = NULL) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either \code{"county"}, \code{"hsa"} (Health Service Area), or -\code{"state"}.} +\item{areatype}{One of the following values: +\itemize{ +\item \code{"county"} +\item \code{"hsa"} (Health Service Area) +\item \code{"state"}. +}} -\item{poverty}{The only permissible values are +\item{poverty}{One of the following values: \itemize{ \item \code{"families below poverty"} \item \code{"persistent poverty"} \item \code{"persons below poverty"} -\item \code{"persons < 150\% of poverty"} +\item \code{"persons < 150\% of poverty"}. }} -\item{race}{One of the following values +\item{race}{One of the following values: \itemize{ -\item "All Races (includes Hispanic)" -\item "White (includes Hispanic)" -\item "White non-Hispanic" -\item "Black" -\item "Amer. Indian/Alaskan Native (includes Hispanic)" -\item "Asian or Pacific Islander (includes Hispanic)" -\item "hispanic (Any Race) +\item \code{"All Races (includes Hispanic)"} +\item \code{"White (includes Hispanic)"} +\item \code{"White non-Hispanic"} +\item \code{"Black"} +\item \code{"Amer. Indian/Alaskan Native (includes Hispanic)"} +\item \code{"Asian or Pacific Islander (includes Hispanic)"} +\item \verb{"Hispanic (Any Race)}. }} \item{sex}{One of the following values \itemize{ -\item "both sexes" -\item "male" -\item "female" +\item \code{"both sexes"} +\item \code{"male"} +\item \code{"female"}. }} } \value{ -A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank +A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank. } \description{ This function returns a data frame about poverty demographics from State Cancer Profiles. diff --git a/man/demo_svi.Rd b/man/demo_svi.Rd index 2fecb16..7aacd1a 100644 --- a/man/demo_svi.Rd +++ b/man/demo_svi.Rd @@ -9,20 +9,20 @@ demo_svi(area, svi) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{svi}{The only permissible values are +\item{svi}{One of the following values: \itemize{ \item \code{"Overall"} \item \code{"socioeconomic status"} \item \code{"household characteristics"} \item \code{"racial & ethinic minority status"} -\item \code{"housing type & transportation"} +\item \code{"housing type & transportation"}. }} } \value{ -A data frame with the following columns County, FIPS, Score +A data frame with the following columns County, FIPS, Score. } \description{ -This function returns a data frame from Social Vulnerability Index (SVI) in State Cancer Profiles +This function returns a data frame from social vulnerability index (SVI) in State Cancer Profiles. } \examples{ \dontrun{ diff --git a/man/demo_workforce.Rd b/man/demo_workforce.Rd index 2b97052..85e4d71 100644 --- a/man/demo_workforce.Rd +++ b/man/demo_workforce.Rd @@ -9,35 +9,39 @@ demo_workforce(area, areatype, workforce, race, sex) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either \code{"county"}, \code{"hsa"} (Health Service Area), or -\code{"state"}.} +\item{areatype}{One of the following values: +\itemize{ +\item \code{"county"} +\item \code{"hsa"} (Health Service Area) +\item \code{"state"}. +}} -\item{workforce}{The only permissible values are +\item{workforce}{The only permissible value is \code{"unemployed"}} -\item{race}{One of the following values +\item{race}{One of the following values: \itemize{ -\item "All Races (includes Hispanic)" -\item "White (includes Hispanic)" -\item "White non-Hispanic" -\item "Black" -\item "Amer. Indian/Alaskan Native (includes Hispanic)" -\item "Asian or Pacific Islander (includes Hispanic)" -\item "hispanic (Any Race) +\item \code{"All Races (includes Hispanic)"} +\item \code{"White (includes Hispanic)"} +\item \code{"White non-Hispanic"} +\item \code{"Black"} +\item \code{"Amer. Indian/Alaskan Native (includes Hispanic)"} +\item \code{"Asian or Pacific Islander (includes Hispanic)"} +\item \verb{"Hispanic (Any Race)}. }} -\item{sex}{One of the following values +\item{sex}{One of the following values: \itemize{ -\item "both sexes" -\item "male" -\item "female" +\item \code{"both sexes"} +\item \code{"male"} +\item \code{"female"}. }} } \value{ -A data frame with the following columns: Area Type, Area Code, Percent, People Unemployed, Rank +A data frame with the following columns: Area Type, Area Code, Percent, People Unemployed, Rank. } \description{ -This function returns a data frame from Workforce in State Cancer Profiles +This function returns a data frame from Workforce in State Cancer Profiles. } \examples{ \dontrun{ diff --git a/man/incidence_cancer.Rd b/man/incidence_cancer.Rd index 1a3dcae..a9ab1c0 100644 --- a/man/incidence_cancer.Rd +++ b/man/incidence_cancer.Rd @@ -9,33 +9,87 @@ incidence_cancer(area, areatype, cancer, race, sex, age, stage, year) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either "county", "hsa" (Health service area), or "state"} +\item{areatype}{One of the following values: +\itemize{ +\item \code{"county"} +\item \code{"hsa"} (Health Service Area) +\item \code{"state"}. +}} -\item{cancer}{Either "all cancer sites","bladder", "brain & ons", "breast (female)", "breast (female in situ)", "cervix", -"childhood (ages <15, all sites)", "childhood (ages <20, all sites)", "colon & rectum", "esophagus", -"kidney & renal pelvis", "leukemia", "liver & bile duct", "lung & bronchus", "melanoma of the skin", -"non-hodgkin lymphoma", "oral cavity & pharynx", "ovary", "pancreas", "prostate", "stomach", -"thyroid", "uterus (corpus & uterus, nos)"} +\item{cancer}{One of the following values: +\itemize{ +\item \code{"all cancer sites"} +\item \code{"bladder"} +\item \code{"brain & ons"} +\item \code{"breast (female)"} +\item \code{"breast (female in situ)"} +\item \code{"cervix"} +\item \code{"childhood (ages <15, all sites)"} +\item \code{"childhood (ages <20, all sites)"} +\item \code{"colon & rectum"} +\item \code{"esophagus"} +\item \code{"kidney & renal pelvis"} +\item \code{"leukemia"} +\item \code{"liver & bile duct"} +\item \code{"lung & bronchus"} +\item \code{"melanoma of the skin"} +\item \code{"non-hodgkin lymphoma"} +\item \code{"oral cavity & pharynx"} +\item \code{"ovary"} +\item \code{"pancreas"} +\item \code{"prostate"} +\item \code{"stomach"} +\item \code{"thyroid"} +\item \code{"uterus (corpus & uterus, nos)"}. +}} -\item{race}{One of the following values: "all races (includes hispanic)", "white (non-hispanic)", -"black (non-hispanic)", "amer. indian / ak native (non-hispanic)", -"asian / pacific islander (non-hispanic)","hispanic (any race)"} +\item{race}{One of the following values: +\itemize{ +\item \code{"All Races (includes Hispanic)"} +\item \code{"White (non-Hispanic)"} +\item \code{"Black (non-Hispanic)"} +\item \code{"American Indian / Alaska Native (non-Hispanic)"} +\item \code{"Asian / Pacific Islander (non-Hispanic)"} +\item \code{"Hispanic (Any Race)"}. +}} -\item{sex}{Either "both sexes", "males", "females"} +\item{sex}{One of the following values: +\itemize{ +\item \code{"both sexes"} +\item \code{"male"} +\item \code{"female"}. +}} -\item{age}{Either "all ages", "ages <50", "ages 50+", "ages <65", "ages 65+", ages <15, ages <20} +\item{age}{One of the following values: +\itemize{ +\item \code{"all ages"} +\item \code{"ages <50"} +\item \code{"ages 50+"} +\item \code{"ages <65"} +\item \code{"ages 65+"} +\item \code{"ages <15"} +\item \code{"ages <20"}. +}} -\item{stage}{Either "all stages" or "late stage (regional & distant)"} +\item{stage}{One of the following values: +\itemize{ +\item \code{"all stages"} +\item \code{"late stage (regional & distant)"}. +}} -\item{year}{Either "latest 5 year average", "latest single year (us by state)"} +\item{year}{One of the following values: +\itemize{ +\item \code{"latest 5 year average"} +\item \code{"latest single year (us by state)"}. +}} } \value{ -A data frame with the following columns: Area Type, Area Code, "Age Adjusted Incidence Rate", "Lower 95\% CI", -"Upper 95\% CI", "CI Rank", "Lower CI Rank", "Upper CI Rank", "Annual Average Count", "Recent Trend", -"Recent 5 Year Trend", "Trend Lower 95\% CI", "Trend Upper 95\% CI" +A data frame with the following columns: Area Type, Area Code, Age Adjusted Incidence Rate, Lower 95\% CI, +Upper 95\% CI, CI Rank, Lower CI Rank, Upper CI Rank, Annual Average Count, Recent Trend, +Recent 5 Year Trend, Trend Lower 95\% CI, Trend Upper 95\% CI. } \description{ -This function returns a data frame from Cancer Incident in State Cancer Profiles +This function returns a data frame about cancer incidence from State Cancer Profiles. } \examples{ \dontrun{ diff --git a/man/mortality_cancer.Rd b/man/mortality_cancer.Rd index 565edeb..956b2d9 100644 --- a/man/mortality_cancer.Rd +++ b/man/mortality_cancer.Rd @@ -9,32 +9,78 @@ mortality_cancer(area, areatype, cancer, race, sex, age, year) \arguments{ \item{area}{A state/territory abbreviation or USA.} -\item{areatype}{Either "county", "hsa" (Health service area), or "state"} +\item{areatype}{One of the following values: +\itemize{ +\item \code{"county"} +\item \code{"hsa"} (Health Service Area) +\item \code{"state"}. +}} -\item{cancer}{Either "all cancer sites","bladder", "brain & ons", "breast (female)", "cervix", -"childhood (ages <15, all sites)", "childhood (ages <20, all sites)", "colon & rectum", "esophagus", -"kidney & renal pelvis", "leukemia", "liver & bile duct", "lung & bronchus", "melanoma of the skin", -"non-hodgkin lymphoma", "oral cavity & pharynx", "ovary", "pancreas", "prostate", "stomach", -"thyroid", "uterus (corpus & uterus, nos)"} +\item{cancer}{One of the following values: +\code{"all cancer sites"} +\verb{"bladder", "brain & ons"} +\code{"breast (female)"} +\code{"cervix"} +\code{"childhood (ages <15, all sites)"} +\code{"childhood (ages <20, all sites)"} +\code{"colon & rectum"} +\code{"esophagus"} +\code{"kidney & renal pelvis"} +\code{"leukemia"} +\code{"liver & bile duct"} +\code{"lung & bronchus"} +\code{"melanoma of the skin"} +\code{"non-hodgkin lymphoma"} +\code{"oral cavity & pharynx"} +\code{"ovary"} +\code{"pancreas"} +\code{"prostate"} +\code{"stomach"} +\code{"thyroid"} +\code{"uterus (corpus & uterus, nos)"}} -\item{race}{One of the following values: "all races (includes hispanic)", "white (non-hispanic)", -"black (non-hispanic)", "amer. indian / ak native (non-hispanic)", -"asian / pacific islander (non-hispanic)","hispanic (any race)"} +\item{race}{One of the following values: +\itemize{ +\item \code{"All Races (includes Hispanic)"} +\item \code{"White (non-Hispanic)"} +\item \code{"Black (non-Hispanic)"} +\item \code{"American Indian / Alaska Native (non-Hispanic)"} +\item \code{"Asian / Pacific Islander (non-Hispanic)"} +\item \code{"Hispanic (Any Race)"}. +}} -\item{sex}{Defaulted to NULL. Specify either "both sexes", "males", "females" if necessary} +\item{sex}{One of the following values: +\itemize{ +\item \code{"both sexes"} +\item \code{"male"} +\item \code{"female"}. +}} -\item{age}{Either "all ages", "ages <50", "ages 50+", "ages <65", "ages 65+", ages <15, ages <20} +\item{age}{One of the following values: +\itemize{ +\item \code{"all ages"} +\item \code{"ages <50"} +\item \code{"ages 50+"} +\item \code{"ages <65"} +\item \code{"ages 65+"} +\item \code{"ages <15"} +\item \code{"ages <20"}. +}} -\item{year}{Either "latest 5 year average", "latest single year (us by state)"} +\item{year}{One of the following values: +\itemize{ +\item \code{"latest 5 year average"} +\item \code{"latest single year (us by state)"}. +}} } \value{ -A data frame with the following columns: Area Type, Area Code, "Met Healthy People Objective of ***?", -"Age Adjusted Death Rate", "Lower 95\% CI Rate", "Upper 95\% CI Rate", -"CI Rank", "Lower CI Rank", "Upper CI Rank", "Annual Average Count", -"Recent Trend", "Recent 5 Year Trend", "Lower 95\% CI Trend", "Upper 95\% CI Trend" +A data frame with the following columns: Area Type, Area Code, Met Healthy People Objective of ***?, +Age Adjusted Death Rate, Lower 95\% CI Rate, Upper 95\% CI Rate, +CI Rank, Lower CI Rank, Upper CI Rank, Annual Average Count, +Recent Trend, Recent 5 Year Trend, Lower 95\% CI Trend, Upper 95\% CI Trend. } \description{ -This function returns a data frame from Cancer Mortality in State Cancer Profiles +This function returns a data frame about cancer mortality from State Cancer Profiles. } \examples{ \dontrun{ diff --git a/man/risk_alcohol.Rd b/man/risk_alcohol.Rd index 0c3967a..ca55be7 100644 --- a/man/risk_alcohol.Rd +++ b/man/risk_alcohol.Rd @@ -8,27 +8,27 @@ risk_alcohol(alcohol, race, sex) } \arguments{ \item{alcohol}{The only permissible value is -\code{"binge drinking (4+ drinks on one occasion for women, 5+ drinks for one occasion for men), ages 21+"}} +\code{"binge drinking (4+ drinks on one occasion for women, 5+ drinks for one occasion for men), ages 21+"}.} \item{race}{One of the following values: \itemize{ -\item "All Races (includes Hispanic)" -\item "White (non-Hispanic)" -\item "Black (non-Hispanic)" -\item "American Indian / Alaska Native (non-Hispanic)" -\item "Asian / Pacific Islander (non-Hispanic)" -\item "Hispanic (Any Race)" +\item \code{"All Races (includes Hispanic)"} +\item \code{"White (non-Hispanic)"} +\item \code{"Black (non-Hispanic)"} +\item \code{"American Indian / Alaska Native (non-Hispanic)"} +\item \code{"Asian / Pacific Islander (non-Hispanic)"} +\item \code{"Hispanic (Any Race)"}. }} -\item{sex}{One of the following values +\item{sex}{One of the following values: \itemize{ -\item "both sexes" -\item "male" -\item "female" +\item \code{"both sexes"} +\item \code{"male"} +\item \code{"female"}. }} } \value{ -A data frame with the following columns: Area Type, Area Code, Percent, Lower 95\% CI, Upper 95\% CI, Number of Respondents +A data frame with the following columns: Area Type, Area Code, Percent, Lower 95\% CI, Upper 95\% CI, Number of Respondents. } \description{ This function returns a data frame about alcohol risks from State Cancer Profiles. diff --git a/man/risk_colorectal_screening.Rd b/man/risk_colorectal_screening.Rd index cfc4113..fe9d894 100644 --- a/man/risk_colorectal_screening.Rd +++ b/man/risk_colorectal_screening.Rd @@ -7,39 +7,39 @@ risk_colorectal_screening(screening, race = NULL, sex = NULL, area = NULL) } \arguments{ -\item{screening}{The only permissible values are +\item{screening}{One of the following values: \itemize{ \item \code{"ever had fobt, ages 50-75"} \item \code{"guidance sufficient crc, ages 50-75"} \item \code{"had colonoscopy in past 10 years, ages 50-75"} \item \code{"home blood stool test in the past year, ages 45-75"} -\item \code{"received at least one recommended crc test, ages 45-75"} +\item \code{"received at least one recommended crc test, ages 45-75"}. }} \item{race}{One of the following values: \itemize{ -\item "All Races (includes Hispanic)" -\item "White (non-Hispanic)" -\item "Black (non-Hispanic)" -\item "American Indian / Alaska Native (non-Hispanic)" -\item "Asian / Pacific Islander (non-Hispanic)" -\item "Hispanic (Any Race)" +\item \code{"All Races (includes Hispanic)"} +\item \code{"White (non-Hispanic)"} +\item \code{"Black (non-Hispanic)"} +\item \code{"American Indian / Alaska Native (non-Hispanic)"} +\item \code{"Asian / Pacific Islander (non-Hispanic)"} +\item \code{"Hispanic (Any Race)"}. }} -\item{sex}{One of the following values +\item{sex}{One of the following values: \itemize{ -\item "both sexes" -\item "male" -\item "female" +\item \code{"both sexes"} +\item \code{"male"} +\item \code{"female"}. }} \item{area}{A state/territory abbreviation or USA.} } \value{ -A data frame with the following columns: Area Type, Area Code, Percent, People Unemployed, Rank +A data frame with the following columns: Area Type, Area Code, Percent, People Unemployed, Rank. } \description{ -This function returns a data frame about Colorectal Screening from State Cancer Profiles. +This function returns a data frame about colorectal screening from State Cancer Profiles. } \examples{ \dontrun{ diff --git a/man/risk_diet_exercise.Rd b/man/risk_diet_exercise.Rd index 20b2569..887e50d 100644 --- a/man/risk_diet_exercise.Rd +++ b/man/risk_diet_exercise.Rd @@ -7,7 +7,7 @@ risk_diet_exercise(diet_exercise, race, sex) } \arguments{ -\item{diet_exercise}{The only permissible values are +\item{diet_exercise}{One of the following values: \itemize{ \item \code{"bmi is healthy, ages 20+"} \item \code{"bmi is obese, ages 20+"} @@ -15,31 +15,31 @@ risk_diet_exercise(diet_exercise, race, sex) \item \code{"bmi is overweight, high school survey"} \item \code{"consumed 1 or more fruits per day"} \item \code{"consumed 1 or more vegetables per day"} -\item \code{"no leisure time physical activity"} +\item \code{"no leisure time physical activity"}. }} \item{race}{One of the following values: \itemize{ -\item "All Races (includes Hispanic)" -\item "White (non-Hispanic)" -\item "Black (non-Hispanic)" -\item "American Indian / Alaska Native (non-Hispanic)" -\item "Asian / Pacific Islander (non-Hispanic)" -\item "Hispanic (Any Race)" +\item \code{"All Races (includes Hispanic)"} +\item \code{"White (non-Hispanic)"} +\item \code{"Black (non-Hispanic)"} +\item \code{"American Indian / Alaska Native (non-Hispanic)"} +\item \code{"Asian / Pacific Islander (non-Hispanic)"} +\item \code{"Hispanic (Any Race)"}. }} -\item{sex}{One of the following values +\item{sex}{One of the following values: \itemize{ -\item "both sexes" -\item "male" -\item "female" +\item \code{"both sexes"} +\item \code{"male"} +\item \code{"female"}. }} } \value{ -A data frame with the following columns: Area Type, Area Code, Percent, Lower 95\% CI, Upper 95\% CI, Number of Respondents +A data frame with the following columns: Area Type, Area Code, Percent, Lower 95\% CI, Upper 95\% CI, Number of Respondents. } \description{ -This function returns a data frame about Diet & Exercise risk from State Cancer Profiles. +This function returns a data frame about diet and exercise risk from State Cancer Profiles. } \examples{ \dontrun{ diff --git a/man/risk_smoking.Rd b/man/risk_smoking.Rd index 53d9667..0fa4d4b 100644 --- a/man/risk_smoking.Rd +++ b/man/risk_smoking.Rd @@ -25,38 +25,42 @@ risk_smoking(smoking, race = NULL, sex = NULL, datatype = NULL, area = NULL) \item \code{"former smoker, quit 1 year+; ages 18+"} \item \code{"smokers (ever); ages 18+"} \item \code{"e-cigarette use; ages 18+"} -\item \code{"smokers (current); ages 18+"} +\item \code{"smokers (current); ages 18+"}. }} \item{race}{One of the following values: \itemize{ -\item "All Races (includes Hispanic)" -\item "White (non-Hispanic)" -\item "Black (non-Hispanic)" -\item "American Indian / Alaska Native (non-Hispanic)" -\item "Asian / Pacific Islander (non-Hispanic)" -\item "Hispanic (Any Race)" +\item \code{"All Races (includes Hispanic)"} +\item \code{"White (non-Hispanic)"} +\item \code{"Black (non-Hispanic)"} +\item \code{"American Indian / Alaska Native (non-Hispanic)"} +\item \code{"Asian / Pacific Islander (non-Hispanic)"} +\item \code{"Hispanic (Any Race)"}. }} \item{sex}{One of the following values \itemize{ -\item "both sexes" -\item "male" -\item "female" +\item \code{"both sexes"} +\item \code{"male"} +\item \code{"female"}. }} -\item{datatype}{Either "direct estimates" or "county level modeled estimates"} +\item{datatype}{One of the following values: +\itemize{ +\item \code{"direct estimates"} +\item \code{"county level modeled estimates"}. +}} \item{area}{A state/territory abbreviation or USA.} } \value{ -A data frame with the following columns: Area Type, Area Code, Percent, Lower CI 95\%, Upper CI 95\%, Number of Respondents +A data frame with the following columns: Area Type, Area Code, Percent, Lower CI 95\%, Upper CI 95\%, Number of Respondents. } \description{ -This function returns a data frame about Smoking risks from State Cancer Profiles. +This function returns a data frame about smoking risks from State Cancer Profiles. } \details{ -Please note that this function requires very specific arguments for each smoking type +Please note that this function requires very specific arguments for each smoking type. } \examples{ \dontrun{ diff --git a/man/risk_vaccines.Rd b/man/risk_vaccines.Rd index 8062b82..2c25820 100644 --- a/man/risk_vaccines.Rd +++ b/man/risk_vaccines.Rd @@ -7,21 +7,21 @@ risk_vaccines(vaccine, sex) } \arguments{ -\item{vaccine}{One of the following values +\item{vaccine}{One of the following values: \itemize{ \item \verb{"percent with up to date hpv vaccination coverage, ages 13-15",} -\item \code{"percent with up to date hpv vaccination coverage, ages 13-17"} +\item \code{"percent with up to date hpv vaccination coverage, ages 13-17"}. }} -\item{sex}{One of the following values +\item{sex}{One of the following values: \itemize{ -\item "both sexes" -\item "male" -\item "female" +\item \code{"both sexes"} +\item \code{"male"} +\item \code{"female"}. }} } \value{ -A data frame with the following columns: Area Type, Area Code, Percent, Lower 95\% CI, Upper 95\% CI, Number of Respondents +A data frame with the following columns: Area Type, Area Code, Percent, Lower 95\% CI, Upper 95\% CI, Number of Respondents. } \description{ This function returns a data frame about vaccines risks from State Cancer Profiles. diff --git a/man/risk_women_health.Rd b/man/risk_women_health.Rd index 8029bb1..e5f7eed 100644 --- a/man/risk_women_health.Rd +++ b/man/risk_women_health.Rd @@ -12,33 +12,33 @@ risk_women_health( ) } \arguments{ -\item{women_health}{One of the following values +\item{women_health}{One of the following values: \itemize{ \item \code{"mammogram in past 2 years, ages 50-74"} \item \code{"mammogram in past 2 years, ages 40+"} -\item \code{"pap smear in past 3 years, no hysterectomy, ages 21-65"} +\item \code{"pap smear in past 3 years, no hysterectomy, ages 21-65"}. }} \item{race}{One of the following values \itemize{ -\item "All Races (includes Hispanic)" -\item "White (non-Hispanic)" -\item "Black (non-Hispanic)" -\item "American Indian / Alaska Native (non-Hispanic)" -\item "Asian / Pacific Islander (non-Hispanic)" -\item "Hispanic (Any Race)" +\item \code{"All Races (includes Hispanic)"} +\item \code{"White (non-Hispanic)"} +\item \code{"Black (non-Hispanic)"} +\item \code{"American Indian / Alaska Native (non-Hispanic)"} +\item \code{"Asian / Pacific Islander (non-Hispanic)"} +\item \code{"Hispanic (Any Race)"}. }} -\item{datatype}{One of the following values +\item{datatype}{One of the following values: \itemize{ \item \code{"direct estimates"} -\item \code{"county level modeled estimates"} +\item \code{"county level modeled estimates"}. }} \item{area}{A state/territory abbreviation or USA.} } \value{ -A data frame with the following columns: Area Type, Area Code, Percent, People Unemployed, Rank +A data frame with the following columns: Area Type, Area Code, Percent, People Unemployed, Rank. } \description{ This function returns a data frame about women's health risks from State Cancer Profiles.