fetch_revenue_series-methods: fetch_revenue_series Methods

In sevenpark/AvenueAPI-R: Retrieve Data from 7Park Data's Avenue API

Description

fetch_revenue_series Methods

Usage

fetch_revenue_series(.Object, firm, data_source, start_date = "",
  end_date = "", validate_name = TRUE)

## S4 method for signature 'AvenueApiClient'
fetch_revenue_series(.Object, firm = NULL,
  data_source = NULL, start_date = "", end_date = "",
  validate_name = TRUE)

Arguments

.Object	A valid AvenueApiClient connection
firm	character; an length-1 vector of the company name, e.g. "Chipotle"
data_source	character; the source dataset. Must be one of: 'cc' (credit card panel), 'm1' (Merchant Intel), 'm2' (Merchant Intel2)
start_date	string; a length-one character vector expressed as 'YYYY-MM-DD' (ISO 8601) representing the start date of series
end_date	string; a length-one character vector expressed as 'YYYY-MM-DD' (ISO 8601) representing the end date of series
validate_name	logical; when TRUE, AvenueAPI checks the supplied firm name against a vector of known/valid names.

Examples

## Not run: 
# Get credit card data for Chipotle
chip <- fetch_revenue_series(connection,
        firm="Chipotle",
        data_source="cc",
        start_date='2015-01-01')

## End(Not run)

sevenpark/AvenueAPI-R documentation built on May 13, 2019, 4:10 a.m.