https://github.com/dylanjm/bjscraper

An API Wrapper for the Bureau of Justice Statistics (BJS)
https://github.com/dylanjm/bjscraper

Last synced: about 6 hours ago
JSON representation

An API Wrapper for the Bureau of Justice Statistics (BJS)

• Host: GitHub
• URL: https://github.com/dylanjm/bjscraper
• Owner: dylanjm
• License: other
• Created: 2018-05-30T07:33:01.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-06-28T04:46:30.000Z (over 5 years ago)
• Last Synced: 2023-07-16T20:10:26.896Z (over 1 year ago)
• Language: R
• Homepage: https://dylanjm.github.io/bjscrapeR/
• Size: 297 KB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# bjscrapeR 

[![Build

Status](https://travis-ci.com/dylanjm/bjscrapeR.svg?branch=master)](https://travis-ci.com/dylanjm/bjscrapeR)

![Current CRAN Version](https://www.r-pkg.org/badges/version/bjscrapeR)

[![Project Status: Active – The project has reached a stable, usable

state and is being actively

developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)

![Total

Downloads](http://cranlogs.r-pkg.org/badges/grand-total/bjscrapeR)

Drawing heavy influence from

[`library(blscrapeR)`](https://github.com/keberwein/blscrapeR), this

library is meant to be a tidy wrapper around the Bureau of Justice

Statistics (BJS) API. The idea is to utilize the ‘tidyverse’ methodology

to create an efficient workflow when dealing with crime statistics.

## Installation

You can install bjscrapeR from github with:

``` r

# install.packages("devtools")

devtools::install_github("dylanjm/bjscrapeR")

```

## Basic Usage

As of right now, the package only comes with one function: `ncvs_api()`,

which queries information from the **National Crime Victimization Survey

(NCVS)**. This data comes in two forms: personal and household crime

statistics with years available from 1993-2016.

``` r

library(bjscrapeR)

crime_dat <- ncvs_api(year = 2012, dataset = "personal")

#> Trying BJS Servers...

#> `curl` package not installed, falling back to using `url()`

#> Payload Successful

head(crime_dat, 5)

#> # A tibble: 5 x 23

#>    year weight gender race1R hispanic ethnic1R  ager marital2 hincome

#>                         

#> 1  2012  2739.      1      1        2        1     6        3      88

#> 2  2012  2739.      1      1        2        1     6        3      88

#> 3  2012  2232.      2      2        2        2     5        1       2

#> 4  2012  1570.      2      2        2        2     6        1       2

#> 5  2012  3097.      1      1        2        1     7        2      88

#> # ... with 14 more variables: popsize , region , msa ,

#> #   direl , notify , weapon , weapcat ,

#> #   newcrime , newoff , seriousviolent , injury ,

#> #   treatment , vicservices , locationr 

```