enigma (version 0.1.1)

enigma_data: Fetch a dataset from Enigma.

Description

Fetch a dataset from Enigma.

Usage

enigma_data(dataset = NULL, limit = 50, select = NULL, sort = NULL,
  page = NULL, where = NULL, search = NULL, key = NULL, ...)

Arguments

dataset

Dataset name. Required.

limit

(numeric) Number of rows of the dataset to return. Default: 50

select

(character) Vector of columns to be returned with each row. Default is to return all columns.

sort

(character) Sort rows by a particular column in a given direction. + denotes ascending order, - denotes descending. See examples.

page

(numeric) Paginate row results and return the nth page of results. Pages are calculated based on the current limit, which defaults to 50.

where

(character) Filter results with a SQL-style "where" clause. Only applies to numerical columns - use the search parameter for strings. Valid operators are >, < and =. Only one where clause per request is currently supported.

search

(character) Filter results by only returning rows that match a search query. By default this searches the entire table for matching text. To search particular fields only, use the query format "@fieldname query". To match multiple queries, the | (or) oper

key

(character) Required. An Enigma API key. Supply in the function call, or store in your .Rprofile file, or do options(enigmaKey = ""). Obtain an API key by creating an account with Enigma at http://enigma.io,

...

Named options passed on to GET

Examples

# After obtaining an API key from Enigma's website, pass in your key to the function call
# or set in your options (see above instructions for the key parameter)
# If you pass in your key to the function call use the key parameter

# White house visitor list
enigma_data(dataset='us.gov.whitehouse.visitor-list')

# White house visitor list - selecting three columns
enigma_data(dataset='us.gov.whitehouse.visitor-list', select=c('namelast','visitee_namelast',
'last_updatedby'))

# White house visitor list - sort by last name
enigma_data(dataset='us.gov.whitehouse.visitor-list', sort='+namelast')

# White house visitor list - get rows where total_people > 5
enigma_data(dataset='us.gov.whitehouse.visitor-list', where='total_people > 5')

# White house visitor list - search for Vitale in full name field
enigma_data(dataset='us.gov.whitehouse.visitor-list', search='@namefull=Vitale')

# White house visitor list - search for SOPHIA in first name field
enigma_data(dataset='us.gov.whitehouse.visitor-list', search='@namefirst=SOPHIA')

# Domestic Market Flight Statistics (Final Destination)
dataset='us.gov.dot.rita.trans-stats.air-carrier-statistics.t100d-market-all-carrier'
enigma_data(dataset=dataset)

# Search for 'apple' in the Crunchbase dataset, and get two columns back
enigma_data(dataset='com.crunchbase.info.companies.acquisition', search='apple',
select=c('acquisition','price_amount'))