Skip to content

Commit e60a3b9

Browse files
Update documentation to midwest variables (#4274)
* Add periods to midwest variables for consistency * Add reference for midwest data See https://git.io/JkSOi (ggplot2 book). * Add missing midwest variable descriptions * Fix variable comment for population to density * Add user note for using midwest dataset * Use canonical form of CRAN acs package link * Document Co-authored-by: GitHub Actions <actions@github.com>
1 parent 12e61df commit e60a3b9

File tree

2 files changed

+45
-34
lines changed

2 files changed

+45
-34
lines changed

R/data.R

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -48,16 +48,21 @@
4848

4949
#' Midwest demographics
5050
#'
51-
#' Demographic information of midwest counties
51+
#' Demographic information of midwest counties from 2000 US census
52+
#'
53+
#' Note: this dataset is included for illustrative purposes. The original
54+
#' descriptions were not documented and the current descriptions here are based
55+
#' on speculation. For more accurate and up-to-date US census data, see the
56+
#' [`acs` package](https://cran.r-project.org/package=acs).
5257
#'
5358
#' @format A data frame with 437 rows and 28 variables:
5459
#' \describe{
55-
#' \item{PID}{}
56-
#' \item{county}{}
57-
#' \item{state}{}
58-
#' \item{area}{}
59-
#' \item{poptotal}{Total population}
60-
#' \item{popdensity}{Population density}
60+
#' \item{PID}{Unique county identifier.}
61+
#' \item{county}{County name.}
62+
#' \item{state}{State to which county belongs to.}
63+
#' \item{area}{Area of county (units unknown).}
64+
#' \item{poptotal}{Total population.}
65+
#' \item{popdensity}{Population density (person/unit area).}
6166
#' \item{popwhite}{Number of whites.}
6267
#' \item{popblack}{Number of blacks.}
6368
#' \item{popamerindian}{Number of American Indians.}
@@ -69,17 +74,17 @@
6974
#' \item{percasian}{Percent Asian.}
7075
#' \item{percother}{Percent other races.}
7176
#' \item{popadults}{Number of adults.}
72-
#' \item{perchsd}{}
77+
#' \item{perchsd}{Percent with high school diploma.}
7378
#' \item{percollege}{Percent college educated.}
74-
#' \item{percprof}{Percent profession.}
75-
#' \item{poppovertyknown}{}
76-
#' \item{percpovertyknown}{}
77-
#' \item{percbelowpoverty}{}
78-
#' \item{percchildbelowpovert}{}
79-
#' \item{percadultpoverty}{}
80-
#' \item{percelderlypoverty}{}
81-
#' \item{inmetro}{In a metro area.}
82-
#' \item{category}{}
79+
#' \item{percprof}{Percent with professional degree.}
80+
#' \item{poppovertyknown}{Population with known poverty status.}
81+
#' \item{percpovertyknown}{Percent of population with known poverty status.}
82+
#' \item{percbelowpoverty}{Percent of people below poverty line.}
83+
#' \item{percchildbelowpovert}{Percent of children below poverty line.}
84+
#' \item{percadultpoverty}{Percent of adults below poverty line.}
85+
#' \item{percelderlypoverty}{Percent of elderly below poverty line.}
86+
#' \item{inmetro}{County considered in a metro area.}
87+
#' \item{category}{Miscellaneous.}
8388
#' }
8489
#'
8590
"midwest"

man/midwest.Rd

Lines changed: 23 additions & 17 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)