available_data: Query API for available Event, Shape or Sensor Network Data

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

Description

Query API for available Event, Shape or Sensor Network Data

Usage

available_data(type, location = NULL, date_begin = NULL, date_end = NULL)

Arguments

type	A character string, one of 'event', 'shape' or 'sensor'
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

Value

A data.table object

Examples

# can use filters
loc = '{"type":"Polygon",
  "coordinates":[
    [[-87.58695602416992,41.79224063145134],
    [-87.58695602416992,41.7996633276003],
    [-87.5745964050293,41.7996633276003],
    [-87.5745964050293,41.79224063145134],
    [-87.58695602416992,41.79224063145134]]]}'
event <- available_data(type = "event", date_begin = "2015-10-20", location = loc)

shapes <- available_data(type = "shape")

sensor <- available_data(type = "sensor")

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