Learn R
pxweb (version 0.9.1)

get_pxweb_data: Get data from a bottom node in PX-WEB API

Description

This function fetches actual data (i.e. values)

Usage

get_pxweb_data(url, dims, clean = FALSE, encoding = NULL)

Arguments

url

URL to get data from (usually sufficient to submit the base URL, supplied via the base_url() function, and the name of the variable).

dims

A list of dimensional parameters to filter data by. Note that values must be submitted for all dimensions of the data. If you don't want to filter data, submit an asterisk in quotation marks ("*") instead of values for that dimension.

clean

Clean and melt the data to R format.

encoding

An encoding for data to get. Normally not requred. Will be supplied to content.

Details

There are five documented filter types in the PX-WEB API documentation; "Item", "All", "Top", "Agg" and "Vs". This function currently only supports the "Item" and "All" modes. To use "Item" selection, simply submit a value or vector of values with each dimensional parameter. To use "All" selection, submit a wildcard asterisk ("*") instead of a value. For detailed examples see the installed example files in the examples folder of path.package("pxweb") (these are also viewable on the project's GitHub page).

See Also

get_pxweb_metadata, get_pxweb_dims, get_pxweb_levels

Examples

Run this code
# NOT RUN {
test_data <- 
  get_pxweb_data(url = "http://api.scb.se/OV0104/v1/doris/sv/ssd/PR/PR0101/PR0101E/Basbeloppet", 
                 dims = list(ContentsCode = c('PR0101A1'), Tid = c('*')),
                 clean = FALSE)
# }

Run the code above in your browser using DataCamp Workspace