gs_gauge_update: Updates and returns a gauge with the updates applied.

View source: R/gauges.R

gs_gauge_updateR Documentation

Updates and returns a gauge with the updates applied.

Description

Updates and returns a gauge with the updates applied.

Usage

gs_gauge_update(id = NULL, tz = "Eastern Time (US & Canada)",
  title = "foo_bar", allowed_hosts = NULL, key = NULL,
  keyname = "GaugesKey", verbose = TRUE)

Arguments

id

Id of the gauge

tz

The time zone that should be used for all date/time operations. See here http://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html for reference.

title

Title of the gauge.

allowed_hosts

Comma or space separated list of domains to accept tracking data from.

key

API key. If left NULL, function looks for key in your options settings defined in the keyname parameter

keyname

Your API key name in your .Rprofile file

verbose

Print http status (default) or not

Details

Note that you can create gaguges with the same names, beware.

Value

Gives HTTP status and metadata for the new gauge.

Note

Note that these examples only work if you provide your Gaug.es API key either by passing in the function, or storing your key in your .Rprofile file, defaults to looking for an entry of "GaugesKey".

Examples

## Not run: 
out <- gs_gauge_create(title='foo_bar')
gs_gauge_update(id=out$id, tz=out$tz, title='dumb')

## End(Not run)

ropensci/rgauges documentation built on May 18, 2022, 6:35 p.m.