This repository has been archived by the owner on Sep 22, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathREADME.Rmd
85 lines (68 loc) · 4.05 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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-"
)
```
# ipumsr <img src="man/figures/logo.png" align="right" height="149" width="128.5"/>
<!-- badges: start -->
[](http://www.repostatus.org/#active)
[](https://CRAN.R-project.org/package=ipumsr)
[](https://github.com/mnpopcenter/ipumsr/actions)
[](https://codecov.io/gh/mnpopcenter/ipumsr?branch=master)
<!-- badges: end -->
The ipumsr package helps import IPUMS extracts from the
[IPUMS website](https://www.ipums.org) into R. IPUMS provides census and
survey data from around the world integrated across time and space. IPUMS
integration and documentation makes it easy to study change, conduct comparative
research, merge information across data types, and analyze individuals within
family and community context. Data and services are available free of charge.
The ipumsr package can be installed by running the following command:
```{r, eval=FALSE}
install.packages("ipumsr")
```
Or, you can install the development version using the following commands:
```{r, eval=FALSE}
if (!require(devtools)) install.packages("devtools")
devtools::install_github("mnpopcenter/ipumsr")
```
## Learning More ##
The vignettes are a great place to learn more about ipumsr and IPUMS data:
- [See the **ipums** vignette for a general introduction](http://tech.popdata.org/ipumsr/articles/ipums.html)
- For a more detailed look at some of the features, see these vignettes:
- [**value-labels**](http://tech.popdata.org/ipumsr/articles/value-labels.html)
- Provides guidance for using the value labels provided by IPUMS
- [**ipums-geography**](http://tech.popdata.org/ipumsr/articles/ipums-geography.html)
- Provides guidance for using R as GIS tool with IPUMS data
- [**ipums-bigdata**](http://tech.popdata.org/ipumsr/articles/ipums-bigdata.html)
- How to handle large IPUMS data extracts and examples of using the chunked versions of microdata reading functions.
- [**ipums-api**](http://tech.popdata.org/ipumsr/dev/articles/ipums-api.html)
- (In-development features not yet on CRAN) How to use the IPUMS USA microdata extract API to define and submit extract requests, check extract status, and download extract files
- Or to see examples of how to work through data from particular projects,
see these vignettes:
- [**ipums-cps**](http://tech.popdata.org/ipumsr/articles/ipums-cps.html)
- An example of using CPS data with the ipumsr package
- [**ipums-nhgis**](http://tech.popdata.org/ipumsr/articles/ipums-nhgis.html)
- An example of using NHGIS data with the ipumsr package
- [**ipums-terra**](http://tech.popdata.org/ipumsr/articles/ipums-terra.html)
- An example of using IPUMS Terra data with the ipumsr package
- [The IPUMS website](https://ipums.org/support/exercises)
- For more project specific exercises
You can access them from R with the `vignette()` command (eg `vignette("value-labels")`).
If you are installing from github and want the vignettes, you'll need to run the following
commands first:
```{r, eval = FALSE}
devtools::install_github("mnpopcenter/ipumsr/ipumsexamples")
devtools::install_github("mnpopcenter/ipumsr", build_vignettes = TRUE)
```
## Development ##
We greatly appreciate bug reports, suggestions or pull requests. They can
be submitted via github, on our [user forum](https://forum.ipums.org) or by email to [email protected]
Before contributing, please be sure to read the
[Contributing Guidelines](https://github.com/mnpopcenter/ipumsr/blob/master/CONTRIBUTING.md)
and the [Code of Conduct](https://github.com/mnpopcenter/ipumsr/blob/master/CONDUCT.md).