gs_gauge_detail: Gets details for a gauge.

View source: R/gauges.R

gs_gauge_detailR Documentation

Gets details for a gauge.

Description

Gets details for a gauge.

Usage

gs_gauge_detail(id, key = NULL, keyname = "GaugesKey", ...)

Arguments

id

id of the gauge

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

...

Curl debugging options passed in to GET

Details

Gets details on a gauge, by specifying the id of the 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: 
# create a dummy gauge
out <- gs_gauge_create()

# and get detail on it
gs_gauge_detail(out$id)

## End(Not run)

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