Skip to content

Commit 88c5bde

Browse files
mine-cetinkaya-rundelthomasp85
authored andcommitted
Minor updates to data docs (#3545)
1 parent 9a45cc8 commit 88c5bde

9 files changed

+54
-32
lines changed

R/data.R

+27-16
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#' Prices of 50,000 round cut diamonds
1+
#' Prices of over 50,000 round cut diamonds
22
#'
33
#' A dataset containing the prices and other attributes of almost 54,000
44
#' diamonds. The variables are as follows:
@@ -26,19 +26,19 @@
2626
#' \url{http://research.stlouisfed.org/fred2}. `economics` is in "wide"
2727
#' format, `economics_long` is in "long" format.
2828
#'
29-
#' @format A data frame with 478 rows and 6 variables
29+
#' @format A data frame with 574 rows and 6 variables:
3030
#' \describe{
3131
#' \item{date}{Month of data collection}
32-
#' \item{psavert}{personal savings rate,
33-
#' \url{http://research.stlouisfed.org/fred2/series/PSAVERT/}}
3432
#' \item{pce}{personal consumption expenditures, in billions of dollars,
3533
#' \url{http://research.stlouisfed.org/fred2/series/PCE}}
36-
#' \item{unemploy}{number of unemployed in thousands,
37-
#' \url{http://research.stlouisfed.org/fred2/series/UNEMPLOY}}
38-
#' \item{uempmed}{median duration of unemployment, in weeks,
39-
#' \url{http://research.stlouisfed.org/fred2/series/UEMPMED}}
4034
#' \item{pop}{total population, in thousands,
4135
#' \url{http://research.stlouisfed.org/fred2/series/POP}}
36+
#' \item{psavert}{personal savings rate,
37+
#' \url{http://research.stlouisfed.org/fred2/series/PSAVERT/}}
38+
#' \item{uempmed}{median duration of unemployment, in weeks,
39+
#' \url{http://research.stlouisfed.org/fred2/series/UEMPMED}}
40+
#' \item{unemploy}{number of unemployed in thousands,
41+
#' \url{http://research.stlouisfed.org/fred2/series/UNEMPLOY}}
4242
#' }
4343
#'
4444
"economics"
@@ -50,7 +50,7 @@
5050
#'
5151
#' Demographic information of midwest counties
5252
#'
53-
#' @format A data frame with 437 rows and 28 variables
53+
#' @format A data frame with 437 rows and 28 variables:
5454
#' \describe{
5555
#' \item{PID}{}
5656
#' \item{county}{}
@@ -85,16 +85,16 @@
8585
"midwest"
8686

8787

88-
#' Fuel economy data from 1999 and 2008 for 38 popular models of car
88+
#' Fuel economy data from 1999 to 2008 for 38 popular models of cars
8989
#'
9090
#' This dataset contains a subset of the fuel economy data that the EPA makes
9191
#' available on \url{http://fueleconomy.gov}. It contains only models which
9292
#' had a new release every year between 1999 and 2008 - this was used as a
9393
#' proxy for the popularity of the car.
9494
#'
95-
#' @format A data frame with 234 rows and 11 variables
95+
#' @format A data frame with 234 rows and 11 variables:
9696
#' \describe{
97-
#' \item{manufacturer}{}
97+
#' \item{manufacturer}{manufacturer name}
9898
#' \item{model}{model name}
9999
#' \item{displ}{engine displacement, in litres}
100100
#' \item{year}{year of manufacture}
@@ -119,7 +119,7 @@
119119
#' Additional variables order, conservation status and vore were added from
120120
#' wikipedia.
121121
#'
122-
#' @format A data frame with 83 rows and 11 variables
122+
#' @format A data frame with 83 rows and 11 variables:
123123
#' \describe{
124124
#' \item{name}{common name}
125125
#' \item{genus}{}
@@ -140,7 +140,13 @@
140140
#' The names of each president, the start and end date of their term, and
141141
#' their party of 11 US presidents from Eisenhower to Obama.
142142
#'
143-
#' @format A data frame with 11 rows and 4 variables
143+
#' @format A data frame with 11 rows and 4 variables:
144+
#' \describe{
145+
#' \item{name}{Last name of president}
146+
#' \item{start}{Presidency start date}
147+
#' \item{end}{Presidency end date}
148+
#' \item{party}{Party of president}
149+
#' }
144150
"presidential"
145151

146152
#' Vector field of seal movements
@@ -161,7 +167,12 @@
161167
#' A 2d density estimate of the waiting and eruptions variables data
162168
#' \link{faithful}.
163169
#'
164-
#' @format A data frame with 5,625 observations and 3 variables.
170+
#' @format A data frame with 5,625 observations and 3 variables:
171+
#' \describe{
172+
#' \item{eruptions}{Eruption time in mins}
173+
#' \item{waiting}{Waiting time to next eruption in mins}
174+
#' \item{density}{2d density estimate}
175+
#' }
165176
"faithfuld"
166177

167178
#' `colors()` in Luv space
@@ -182,7 +193,7 @@
182193
#'
183194
#' @format A data frame with 8602 observations and 9 variables:
184195
#' \describe{
185-
#' \item{city}{Name of MLS area}
196+
#' \item{city}{Name of multiple listing service (MLS) area}
186197
#' \item{year,month,date}{Date}
187198
#' \item{sales}{Number of sales}
188199
#' \item{volume}{Total value of sales}

man/diamonds.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/economics.Rd

+7-7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/faithfuld.Rd

+6-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/midwest.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/mpg.Rd

+3-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/msleep.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/presidential.Rd

+7-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/txhousing.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)