GitXplorerGitXplorer
n

ukpolice

public
36 stars
9 forks
11 issues

Commits

List of commits on branch master.
Unverified
721dda20bd98f0632ccc2cdf89998b545cf86b04

add hex and update suggests to include ggplot2 and leaflet

nnjtierney committed 7 years ago
Unverified
12ca29375d54473d88bac47fed4238d3618ffc1b

update pkgdown

nnjtierney committed 7 years ago
Unverified
3899c0d114b17f983e91efc02c96762e7a547fcf

version bump, update DESCRIPTION and NEWS file

nnjtierney committed 7 years ago
Unverified
86875fd756d57b788a799792efb96b4282e12016

update README

nnjtierney committed 7 years ago
Unverified
0b164705d4c3c35f8372aa5f38575832bca78d22

added vignette

nnjtierney committed 7 years ago
Unverified
4c435626e88535366394e3e58711b4bc8f091460

rejig README figs

nnjtierney committed 7 years ago

README

The README file for this repository.

ukpolice

AppVeyor Build StatusTravis-CI Build StatusCoverage Status lifecycle

ukpolice is an R package that facilitates retrieving data from the UK police database.. The data provided by the API contains public sector information licensed under the Open Government Licence v3.0.

Installation

Install from GitHub

#install.packages("remotes")
remotes::install_github("njtierney/ukpolice")

Get the crime data with ukp_crime

ukp_crime() draws crimes from within a one mile radius of the location. When no date is specified, it uses the latest month available, which can be found using ukp_last_update().

library(ukpolice)

crime_data <- ukp_crime(lat = 52.629729, lng = -1.131592)
#> No encoding supplied: defaulting to UTF-8.

head(crime_data)
#> # A tibble: 6 x 12
#>   category persistent_id date    lat  long street_id street_name context
#>   <chr>    <chr>         <chr> <dbl> <dbl> <chr>     <chr>       <chr>  
#> 1 anti-so… ""            2018…  52.6 -1.13 883389    On or near… ""     
#> 2 anti-so… ""            2018…  52.6 -1.13 883356    On or near… ""     
#> 3 anti-so… ""            2018…  52.6 -1.14 883430    On or near… ""     
#> 4 anti-so… ""            2018…  52.6 -1.13 883378    On or near… ""     
#> 5 anti-so… ""            2018…  52.6 -1.12 883201    On or near… ""     
#> 6 anti-so… ""            2018…  52.6 -1.14 883426    On or near… ""     
#> # … with 4 more variables: id <chr>, location_type <chr>,
#> #   location_subtype <chr>, outcome_status <chr>

ukp_last_update()
#> No encoding supplied: defaulting to UTF-8.
#> [1] "2018-11"

Specify a month and year for data

When date is specified, it must be in the format “YYYY-MM”. Currently ukp_crime() only allows for searching of that current month.

crime_data_date <- ukp_crime(lat = 52.629729, 
                             lng = -1.131592,
                             date = "2016-03")
#> No encoding supplied: defaulting to UTF-8.

head(crime_data_date)
#> # A tibble: 6 x 12
#>   category persistent_id date    lat  long street_id street_name context
#>   <chr>    <chr>         <chr> <dbl> <dbl> <chr>     <chr>       <chr>  
#> 1 anti-so… ""            2016…  52.6 -1.13 883288    On or near… ""     
#> 2 anti-so… ""            2016…  52.6 -1.13 883321    On or near… ""     
#> 3 anti-so… ""            2016…  52.6 -1.13 883362    On or near… ""     
#> 4 anti-so… ""            2016…  52.6 -1.13 883388    On or near… ""     
#> 5 anti-so… ""            2016…  52.6 -1.13 883359    On or near… ""     
#> 6 anti-so… ""            2016…  52.6 -1.11 883060    On or near… ""     
#> # … with 4 more variables: id <chr>, location_type <chr>,
#> #   location_subtype <chr>, outcome_status <chr>

This is still a little buggy at the moment as it returns blank columns for variables like persistent_id and context, location_subtype, and outcome_status. This issue is currently logged at issue #11.

Example usage

Explore the number of crime types

library(dplyr)
#> 
#> Attaching package: 'dplyr'
#> The following objects are masked from 'package:stats':
#> 
#>     filter, lag
#> The following objects are masked from 'package:base':
#> 
#>     intersect, setdiff, setequal, union
library(ggplot2)

crime_data <- ukp_crime(lat = 52.629729, lng = -1.131592)
#> No encoding supplied: defaulting to UTF-8.

crime_data %>%
  count(category) %>%
  ggplot(aes(x = reorder(category, n),
             y = n)) + 
  geom_col() + 
  labs(x = "Crime Type",
       y = "Number of Crimes",
       title = paste0("Crimes commited in ",crime_data$date[1])) +
  coord_flip() +
  theme_minimal()

Using leaflet

You can add a popup that displays the crime type using the popup argument in leaflet.

library(leaflet)
crime_data <- ukp_crime(lat = 52.629729, lng = -1.131592)
#> No encoding supplied: defaulting to UTF-8.
crime_data %>%
  leaflet() %>%
  addTiles() %>%
  addCircleMarkers(popup = ~category)
#> Assuming "long" and "lat" are longitude and latitude, respectively

Other use of ukpolice

ukpolice does other things! At the moment other features include:

  • Get crime within a polygon with ukp_crime_poly()
  • Retrieve a list of neighbourhoods for a police force with ukp_neighbourhood()

To see these examples, read the vignette “Getting Started with ukpolice”.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Thanks

hex sticker police logo “Police” created by Yu luck from the Noun Project, hex sticker made with hexSticker package