-
Notifications
You must be signed in to change notification settings - Fork 3
/
README.Rmd
158 lines (107 loc) · 7.51 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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
---
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%"
)
```
# IMD <img src='man/figures/logo.png' align="right" height="150" /></a>
<!-- badges: start -->
[](https://www.repostatus.org/#active)
[](https://cran.r-project.org/package=IMD)
<!-- badges: end -->
The `IMD` package provides easy access to the Indices of Multiple Deprivation for the UK's nations at various geographical levels:
- England: Lower Layer Super Output Area (LSOA), Middle Layer Super Output Area (MSOA), Ward, and Local Authority
- Wales: LSOA, MSOA, Ward, and Local Authority
- Scotland: Data Zone, Intermediate Zone, and Council Area
- Northern Ireland: Super Output Area and Local Government District
## Installation
Install the released version of `IMD` from [CRAN](https://cran.r-project.org/package=IMD):
``` r
install.packages("IMD")
```
Alternatively, you can install the development version from [GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("humaniverse/IMD")
```
## Usage
The `IMD` package provides several datasets for the IMD in each UK nation:
### England
- Lower Layer Super Output Areas: `IMD::imd_england_lsoa`
- Middle Layer Super Output Areas: `IMD::imd_england_msoa`
- Wards: `IMD::imd_england_ward`
- Local Authorities: `IMD::imd_england_lad`
**Sub-domains of deprivation** are also available for England. These include two in the Education domain ('children and young people' and 'adult skills'), two for the Barriers domain ('geographical barriers' and 'wider barriers'), and two for the Living Environment domain ('indoors' and 'outdoors')
- Sub-domains for LSOAs: `IMD::imd_england_lsoa_subdomains`
- Sub-domains for MSOAs: `IMD::imd_england_msoa_subdomains`
- Sub-domains for wards: `IMD::imd_england_ward_subdomains`
- Sub-domains for Local Authorities: `IMD::imd_england_lad_subdomains`
**Community Needs Index:** `IMD::cni_england_ward17`
### Wales
- Lower Layer Super Output Areas: `IMD::imd_wales_lsoa`
- Middle Layer Super Output Areas: `IMD::imd_wales_msoa`
- Wards: `IMD::imd_wales_ward`
- Local Authorities: `IMD::imd_wales_lad`
**Community Needs Index:** `IMD::cni_wales_msoa11`
### Scotland
- Data Zones: `IMD::imd_scotland_dz`
- Intermediate Zones: `IMD::imd_scotland_iz`
- Council Areas: `IMD::imd_scotland_lad`
**Community Needs Index:** `IMD::cni_scotland_iz11`
### Northern Ireland
- Super Output Areas: `IMD::imd_northern_ireland_soa`
- Local Government Districts: `IMD::imd_northern_ireland_lad`
**Community Needs Index:** `IMD::cni_northern_ireland_soa11`
### Composite 2020 UK Index of Multiple Deprivation
We have also included the [composite 2020 UK Index of Multiple Deprivation](https://github.com/mysociety/composite_uk_imd) produced by mySociety, allowing comparison of deprivation across UK nations. For more information about how and when to use this version of the IMD, see [their README](https://github.com/mysociety/composite_uk_imd/blob/master/readme.md).
Rather than providing a copy of this data, the `IMD` package loads the data hosted on mySociety's GitHub. To load these files, run the following code:
```r
imd_uk <- load_composite_imd(nation = "E")
```
This function defaults to loading the England-focused composite index; change the `nation` parameter to the first letter of one of the devolved UK nations to load the other versions.
## Example
How many wards in Wales are there with the 100% of the population living in areas classified as among the most deprived?
```{r example}
library(IMD)
imd_wales_ward |>
dplyr::filter(Extent == 1) |>
dplyr::count()
```
## Accessing the data for non-R users
We've provided `.csv` files for each geographical area in each nation:
### England
- Lower Layer Super Output Areas: [imd_england_lsoa.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/imd_england_lsoa.csv)
- Middle Layer Super Output Areas: [imd_england_msoa.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/imd_england_msoa.csv)
- Wards: [imd_england_ward.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/imd_england_ward.csv)
- Local Authorities: [imd_england_lad.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/imd_england_lad.csv)
**Sub-domains of deprivation** are also available for England. These include two in the Education domain ('children and young people' and 'adult skills'), two for the Barriers domain ('geographical barriers' and 'wider barriers'), and two for the Living Environment domain ('indoors' and 'outdoors')
- Sub-domains for LSOAs: [imd_england_lsoa_subdomains.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/imd_england_lsoa_subdomains.csv)
- Sub-domains for MSOAs: [imd_england_msoa_subdomains.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/imd_england_msoa_subdomains.csv)
- Sub-domains for wards: [imd_england_ward_subdomains.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/imd_england_ward_subdomains.csv)
- Sub-domains for Local Authorities: [imd_england_lad_subdomains.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/imd_england_lad_subdomains.csv)
**Community Needs Index:** [community-needs-index-england.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/community-needs-index-england.csv)
### Wales
- Lower Layer Super Output Areas: [imd_wales_lsoa.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/imd_wales_lsoa.csv)
- Middle Layer Super Output Areas: [imd_wales_msoa.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/imd_wales_msoa.csv)
- Wards: [imd_wales_ward.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/imd_wales_ward.csv)
- Local Authorities: [imd_wales_lad.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/imd_wales_lad.csv)
**Community Needs Index:** [community-needs-index-wales.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/community-needs-index-wales.csv)
### Scotland
- Data Zones: [imd_scotland_dz.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/imd_scotland_dz.csv)
- Intermediate Zones: [imd_scotland_iz.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/imd_scotland_iz.csv)
- Council Areas: [imd_scotland_lad.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/imd_scotland_lad.csv)
**Community Needs Index:** [community-needs-index-scotland.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/community-needs-index-scotland.csv)
### Northern Ireland
- Super Output Areas: [imd_northern_ireland_soa.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/imd_northern_ireland_soa.csv)
- Local Government Districts: [imd_northern_ireland_lad.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/imd_northern_ireland_lad.csv)
**Community Needs Index:** [community-needs-index-northern-ireland.csv](https://github.com/humaniverse/IMD/raw/master/data-raw/community-needs-index-northern-ireland.csv)
## Getting help
If you encounter a clear bug, please file an issue with a minimal reproducible example on [GitHub](https://github.com/humaniverse/IMD/issues).
---
Please note that this project is released with a [Contributor Code of Conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/). By participating in this project you agree to abide by its terms.