Skip to content

Commit

Permalink
Updating man pages for some datasets
Browse files Browse the repository at this point in the history
  • Loading branch information
ehumph committed Jul 5, 2024
1 parent 8aca7ee commit 5061ff5
Show file tree
Hide file tree
Showing 3 changed files with 115 additions and 39 deletions.
92 changes: 75 additions & 17 deletions R/CO_heat_ER.R
Original file line number Diff line number Diff line change
@@ -1,55 +1,113 @@
#' Colorado Heat-related Emergency Room Visits (Age Adjusted) Data
#' Age-adjusted heat-related ER visits between 2011 and 2022, as reported by the state of Colorado
#'
#' A dataset used in the DaSEH Short Course. More here..
#' A dataset used in the DaSEH Short Course. This data is gathered by the Colorado Environmental Public Health Tracking program.
#'
#' @source Created using data downloaded from x.
#' @format A data frame with 2340 rows and 7 columns.
#' \describe{
#' \item{county}{CO county which reported the datapoint}
#' \item{rate}{Age-adjusted rate of heat-related ER visits}
#' \item{lower95cl}{Lower 95% confidence limit for the age-adjusted rate}
#' \item{upper95cl}{Upper 95% confidence limit for the age-adjusted rate}
#' \item{visits}{Total number of heat-related ER visits}
#' \item{year}{Year between 2011 and 2022}
#' \item{gender}{Gender, with the option of 'female', 'male', and 'both genders'}
#'}
#'
#' @source Created using data downloaded from the Colorado Environmental Public Health Tracking program website
#'
#' @examples
#' data(CO_heat_ER)
"CO_heat_ER"


#' Colorado Heat-related Emergency Room Visits (Age Adjusted) by Age Data

#' Statewide heat-related ER visits between 2011 and 2022 by age category, as reported by the state of Colorado.
#'
#' A dataset used in the DaSEH Short Course. More here..
#' A dataset used in the DaSEH Short Course. This data is gathered by the Colorado Environmental Public Health Tracking program.
#'
#' @source Created using data downloaded from x.
#' @format A data frame with 216 rows and 7 columns.
#' \describe{
#' \item{YEAR}{Year between 2011 and 2022}
#' \item{GENDER}{Gender, with the option of 'female', 'male', and 'both genders'}
#' \item{AGE}{Age category, with the options of '0-4 years old', '5-14 years old', '15-34 years old', '35-64 years old', '65+ years old', and 'All ages'}
#' \item{RATE}{Rate of heat-related ER visits}
#' \item{L95CL}{Lower 95% confidence limit of the rate estimate}
#' \item{U95CL}{Upper 95% confidence limit of the rate estimate}
#' \item{VISITS}{Number of heat-related ER visits}
#'}
#'
#' @source Created using data downloaded from the Colorado Environmental Public Health Tracking program website
#'
#' @examples
#' data(CO_heat_ER_byage)
"CO_heat_ER_byage"


#' Colorado Heat-related Emergency Room Visits (Age Adjusted) by Gender Data

#' Subset of county-level age-adjusted heat-related ER visits between 2011 and 2022 by age category broken down by gender, as reported by the state of Colorado.
#'
#' A dataset used in the DaSEH Short Course. More here..
#' A dataset used in the DaSEH Short Course. This data is gathered by the Colorado Environmental Public Health Tracking program.
#'
#' @source Created using data downloaded from x.
#' @format A data frame with 240 rows and 7 columns.
#' \describe{
#' \item{county}{CO county which reported the datapoint}
#' \item{rate}{Age-adjusted rate of heat-related ER visits}
#' \item{lower95cl}{Lower 95% confidence limit for the age-adjusted rate}
#' \item{upper95cl}{Upper 95% confidence limit for the age-adjusted rate}
#' \item{visits}{Total number of heat-related ER visits}
#' \item{year}{Year between 2011 and 2022}
#' \item{gender}{Gender, with the option of 'female', 'male', and 'both genders'}
#'}
#'
#' @source Created using data downloaded from the Colorado Environmental Public Health Tracking program website
#'
#' @examples
#' data(CO_heat_ER_bygender)
"CO_heat_ER_bygender"


#' Colorado Heat-related Emergency Room Visits (Age Adjusted) Data.
#' Long-formatted dataset of age-adjusted heat-related ER visits between 2011 and 2022 for Boulder and Denver counties, as reported by the state of Colorado.
#'
#' A dataset used in the DaSEH Short Course. This data is gathered by the Colorado Environmental Public Health Tracking program.
#'
#' A dataset used in the DaSEH Short Course. This data is in long, or "tidy",
#' form. More here..
#' @format A data frame with 24 rows and 3 columns.
#' \describe{
#' \item{county}{CO county, with the option of 'Boulder' or 'Denver'}
#' \item{rate}{Age-adjusted rate of heat-related ER visits}
#' \item{year}{Year between 2011 and 2022}
#'}
#'
#' @source Created using data downloaded from x.
#' @source Created using data downloaded from the Colorado Environmental Public Health Tracking program website
#'
#' @examples
#' data(CO_heat_ER_long)
"CO_heat_ER_long"


#' Colorado Heat-related Emergency Room Visits (Age Adjusted) Data.
#' Wide-formatted dataset of age-adjusted heat-related ER visits between 2011 and 2022 for Boulder and Denver counties, as reported by the state of Colorado.
#'
#' A dataset used in the DaSEH Short Course. This data is in wide form. More
#' here..
#' A dataset used in the DaSEH Short Course. This data is gathered by the Colorado Environmental Public Health Tracking program.
#'
#' @source Created using data downloaded from x.
#' @format A data frame with 2 rows and 13 columns.
#' \describe{
#' \item{county}{CO county, with the option of 'Boulder' or 'Denver'}
#' \item{2011}{Age-adjusted rate for 2011}
#' \item{2012}{Age-adjusted rate for 2012}
#' \item{2013}{Age-adjusted rate for 2013}
#' \item{2014}{Age-adjusted rate for 2014}
#' \item{2015}{Age-adjusted rate for 2015}
#' \item{2016}{Age-adjusted rate for 2016}
#' \item{2017}{Age-adjusted rate for 2017}
#' \item{2018}{Age-adjusted rate for 2018}
#' \item{2019}{Age-adjusted rate for 2019}
#' \item{2020}{Age-adjusted rate for 2020}
#' \item{2021}{Age-adjusted rate for 2021}
#' \item{2022}{Age-adjusted rate for 2022}
#'}
#'
#' @source Created using data downloaded from the Colorado Environmental Public Health Tracking program website
#'
#' @examples
#' data(CO_heat_ER_wide)
"CO_heat_ER_wide"

35 changes: 27 additions & 8 deletions R/er_CO.R
Original file line number Diff line number Diff line change
@@ -1,20 +1,39 @@
#' Colorado Statewide Heat-related Emergency Room Visits (Age Adjusted) Data.
#' Statewide age-adjusted heat-related ER visits between 2011 and 2022, as reported by the state of Colorado. No breakdown by county, gender, or age category.
#'
#' A dataset used in the DaSEH Short Course. Data is in "long" form. More here..
#' A dataset used in the DaSEH Short Course. This data is gathered by the Colorado Environmental Public Health Tracking program.
#'
#' @source Created using data downloaded from x.
#' @format A data frame with 12 rows and 5 columns.
#' \describe{
#' \item{rate}{Age-adjusted rate of heat-related ER visits}
#' \item{lower95cl}{Lower 95% confidence limit for the age-adjusted rate}
#' \item{upper95cl}{Upper 95% confidence limit for the age-adjusted rate}
#' \item{visits}{Total number of heat-related ER visits}
#' \item{year}{Year between 2011 and 2022}
#'}
#'
#' @source Created using data downloaded from the Colorado Environmental Public Health Tracking program website
#'
#' @examples
#' data(er_CO_statewide)
"er_CO_statewide"


#' Colorado Heat-related Emergency Room Visits (Age Adjusted) Data
#' County-level age-adjusted heat-related ER visits between 2011 and 2022, as reported by the state of Colorado. COntains a subset of Colorado counties.
#'
#' A dataset used in the DaSEH Short Course. This data is gathered by the Colorado Environmental Public Health Tracking program.
#'
#' A dataset used in the DaSEH Short Course. Data is in "long" form. More here..
#' @format A data frame with 205 rows and 6 columns.
#' \describe{
#' \item{county}{Colorado county reporting the data}
#' \item{rate}{Age-adjusted rate of heat-related ER visits}
#' \item{lower95cl}{Lower 95% confidence limit for the age-adjusted rate}
#' \item{upper95cl}{Upper 95% confidence limit for the age-adjusted rate}
#' \item{visits}{Total number of heat-related ER visits}
#' \item{year}{Year between 2011 and 2022}
#'}
#'
#' @source Created using data downloaded from x.
#' @source Created using data downloaded from the Colorado Environmental Public Health Tracking program website
#'
#' @examples
#' data(er_visits_by_CO_county)
"er_visits_by_CO_county"
#' data(er_CO_by_CO_county)
"er_CO_by_CO_county"
27 changes: 13 additions & 14 deletions man/dasehr-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 5061ff5

Please sign in to comment.