RGeckoboard (version 0.1-5)

geckoCustomWidgetUpdate: Update or Create a Custom Widget

Description

Update the data of a Custom Widget by Push methodology. If not existing, create a new one. If x axis values are of class Date, x axis format is auto-adjusted therefore.

Usage

geckoCustomWidgetUpdate(widgetType="barchart", data, apiKey, widgetKey, 
verbose=FALSE)

Arguments

widgetType

Chart Type, see https://developer-custom.geckoboard.com/#custom-widget-types.

data

For "barchart" a list with the following elements (mostly optional):

y

data.frame w/ 1 column per series. N rows.

y.format

Optional. "decimal", "percent" or "currency". Defaults to "decimal".

y.unit

Optional. For currencied "GBP", "USD" or "EUR".

x

Optional. Vector of length N with bar labels.

For "geckometer" a list with the following elements:

current

Current value. Numeric.

min

Min (left) value. Numeric.

max

Max (right) value. Numeric.

format

Optional. "percent" or "currency". Defaults is "decimal".

unit

Optional. For currencied "GBP", "USD" or "EUR".

apiKey

API key.

widgetKey

Widget Key, see https://developer-custom.geckoboard.com/#pushing-to-your-widget.

verbose

If TRUE, API repsonse if printed.

Value

Nothing is returned.