README.md

In TiagoVentura/get_fogocruzado:

fogocruzado: A R Package to download data on shootings in Brazil

Introduction

This project is an simple R package that provides an interface to easily interact with the API of the NGO Fogo Cruzado in Brazil. The API guarantees access to a unique dataset on shootings in some of the major cities in Brazil. We are extremely thankful for the work of the Fogo Cruzado, and decided to wrdevtools::install_github("silvadenisson/electionsBR") ite this R package to provide simple and easy access to their API.

Functions

The main function is \code{get_occurences} to access their data. The output can be filtered by the source of shootings, the presence of a state police officer, the state and the city.

Beyond that, the package also provides some functions to see the filters: \code{data_source}, \code{data_state}, \code{data_cities}, \code{data_agent}.

I also wrote a function to easily communicate with the API and get the user's token: \code{get_token}.

TiagoVentura/get_fogocruzado documentation built on June 27, 2019, 12:19 a.m.