-
Notifications
You must be signed in to change notification settings - Fork 3
/
README.Rmd.orig
100 lines (70 loc) · 3.84 KB
/
README.Rmd.orig
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
---
title: "crimedata"
output: github_document
---
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
<!-- badges: start -->
[](https://CRAN.R-project.org/package=crimedata)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
<!-- badges: end -->
The goal of crimedata is to access police-recorded crime data from large US cities using the [Crime Open Database](https://osf.io/zyaqn/) (CODE), a service that provides these data in a convenient format for analysis. All the data are available to use for free as long as you acknowledge the source of the data.
The function `get_crime_data()` returns a [tidy](https://CRAN.R-project.org/package=tidyr) data [tibble](https://CRAN.R-project.org/package=tibble) or [simple features (SF) object](https://CRAN.R-project.org/package=sf) of crime data with each row representing a single crime. The data provided for each offense includes the offense type, approximate offense location and date/time. More fields are available for some records, depending on what data have been released by each city. For most cities, data are available from 2010 onward, with some available back to 2007. Use `list_crime_data()` to see which years are available for which cities.
More detail about what data are available, how they were constructed and the meanings of the different categories can be found on the [CODE project website](https://osf.io/zyaqn/). Further detail is available in the paper [Studying Crime and Place with the Crime Open Database](https://doi.org/10.1163/24523666-00401007).
Installation
------------
You can install the crimedata package with:
```r
install.packages("crimedata")
```
You can install the latest development version of the crimedata package from GitHub with:
```r
# install.packages("remotes")
remotes::install_github("mpjashby/crimedata")
```
Examples
--------
Data can be downloaded by year and by city. By default (i.e. if no arguments are specified) a 1% sample of data for all cities for the most recent available year is returned.
```{r crimedata_setup, echo=FALSE}
library(crimedata)
```
```{r crimedata_loading, eval=FALSE}
library(crimedata)
crime_data <- get_crime_data()
```
The data are in a tidy format, so can be quickly manipulated using [dplyr](https://CRAN.R-project.org/package=dplyr) verbs. For example, to analyze two years of personal robberies in Chicago and Detroit, you can run:
```{r crimedata_dplyr_example}
suppressPackageStartupMessages(library(tidyverse))
personal_robberies <- get_crime_data(
years = 2009:2010,
cities = c("Chicago", "Detroit"),
type = "core",
quiet = TRUE
) %>%
filter(offense_type == "personal robbery")
```
You can alternatively get a [simple features (SF)](https://r-spatial.github.io/sf/articles/sf1.html) point object with the correct co-ordinates and co-ordinate reference system (CRS) specified by setting the argument `output = "sf"`. This can be used, for example, to quickly plot the data.
```{r crimedata_sf_example, fig.asp=0.33, fig.retina=2}
suppressPackageStartupMessages(library(lubridate))
get_crime_data(
cities = "Fort Worth",
years = 2014:2017,
type = "core",
quiet = TRUE,
output = "sf"
) %>%
filter(offense_group == "homicide offenses") %>%
mutate(offense_year = year(date_single)) %>%
ggplot() +
geom_sf() +
facet_wrap(vars(offense_year), nrow = 1)
```
Included data
-------------
The package includes two datasets. `homicides15` contains records of 1,922 recorded homicides in nine US cities in 2015. `nycvehiclethefts` contains records of 35,746 thefts of motor vehicles in New York City from 2014 to 2017. These may be particularly useful for teaching purposes.