rdatamarket (version 0.6.5)

dminfo: Fetch information about a DataMarket dataset.

Description

This function makes an info API call to fetch metadata (including dimension structure) of a DataMarket dataset.

Usage

dminfo(ds, .params = list())

Arguments

ds

a dataset ID, DS string, URL query-string, or whole URL. The DS string to send is extracted from the URL as needed, and short URLs at data.is, bit.ly, is.gd, t.co and url.is are expanded.

.params

extra GET parameters to pass along in the API request.

Value

a structure of named lists representing the dataset metadata. If the resolved DS string is a multiple-dataset DS string (that is, contains / forward-slash characters), then the returned value is a named list of such structures, with `strsplit(ds, '/')` as names.

Examples

dminfo("17tm")
dminfo("17tm!kqc=a")
dminfo("ds=17tm")
dminfo("ds=17tm!kqc=a")
dminfo("foo=bar&ds=17tm&baz=xyzzy")
dminfo("http://datamarket.com/api/v1/series.json?foo=bar&ds=17tm&baz=xyzzy")
dminfo("http://datamarket.com/data/set/17tm/#ds=17tm")
dminfo("http://datamarket.com/data/set/12r9/male-population-thousands")