-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.Rmd
71 lines (50 loc) · 3.62 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# usdata <a href="https://openintrostat.github.io/usdata/"><img src="man/figures/logo.png" align="right" alt="Hex logo for package" height="120" /></a>
<!-- badges: start -->
[](https://CRAN.R-project.org/package=usdata)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://cran.r-project.org/package=usdata)
[](https://github.com/OpenIntroStat/usdata/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
This package contains demographic data on the United States at the county and state levels. The data span multiple years. Sources include the US Census, the American Community Survey, data distributed by the Bureau of Labor Statistics, etc.
## Installation
You can install the package from [CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("usdata")
```
Additionally, you can install the development version of usdata from GitHub with:
```r
#install.packages("devtools")
library(devtools)
install_github("OpenIntroStat/usdata")
```
## Usage
The datasets from this package can be used in a teaching context for data visualization and data manipulation exercises as well as for modeling. Since data spans multiple years it's also possible to use these data to explore trends in the US over time.
## usdata and openintro
The datasets from this package are used in [OpenIntro](https://www.openintro.org/) textbooks and other resources.
These datasets originally lived in the [**openintro**](http://openintrostat.github.io/openintro/) package, up until openintro 2.0.0.
The motivation for extracting these datasets out of the openintro package was to create a new package where we can continue to add more data on the US at the state and county levels.
For those looking for a seamless experience with OpenIntro resources, note that the contents of this package will be loaded along with the openintro package as well, so that you can run `library(openintro)` and use the datasets from usdata.
## Questions, bugs, feature requests
You can file an issue to get help, report a bug, or make a feature request.
When filing an issue to get help or report a bug, please make a minimal **repr**oducible **ex**ample using the [reprex](https://reprex.tidyverse.org/) package.
If you haven't heard of or used reprex before, you're in for a treat!
See [here](https://www.tidyverse.org/help/) for additional reprex pointers.
Before opening a new issue, be sure to [search issues and pull requests](https://github.com/openintrostat/usdata/issues) to make sure the bug hasn't been reported and/or already fixed in the development version.
By default, the search will be pre-populated with `is:issue is:open`.
You can [edit the qualifiers](https://help.github.com/articles/searching-issues-and-pull-requests/) (e.g. `is:pr`, `is:closed`) as needed.
For example, you'd simply remove `is:open` to search _all_ issues in the repository, open or closed.
## Code of Conduct
Please note that the usdata project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html).
By contributing to this project, you agree to abide by its terms.