event_data: Dump all records for an event data set

In McClellandLegge/plenar: Data Extraction to R from Plenar.io's API

Description

Dump all records for an event data set

Usage

event_data(name = NULL, location = NULL, date_begin = NULL,
  date_end = NULL, filter = NULL)

Arguments

name	The name of the dataset to extract
location	('type = "event"' and 'type = "shape"' only) filter data sets with a valid geojson polygon
date_begin	('type = "event"' only) filter data sets for those that begin on or after this date specified in 'YYYY-MM-DD' format
date_end	('type = "event"' only) filter data sets for those that end on or before this date specified in 'YYYY-MM-DD' format
filter	Attribute filtering, see the [documentation](http://docs.plenar.io/#attribute-filtering)

Value

A data.table

Examples

x <- event_data(name = "crimes_2001_to_present",
  filter = '{"op": "eq", "col": "primary_type", "val": "HOMICIDE"}',
  date_begin = "2016-12-01", date_end = "2016-12-31")

McClellandLegge/plenar documentation built on May 8, 2019, 9:50 a.m.