R interface to the PX-Web/PC-Axis API


[Up] [Top]

Documentation for package ‘pxweb’ version 0.4

Help Pages

pxweb-package pxweb
api_parameters Return options for database, version and language choices
api_timer Creates a timer that keeps track of how many calls that has been called during a time period depending on the api configuration. If there can't be another call the function pauses R to do the call.
base_url Return base URL to API
buildPath Build a path from character elements
calculate_data_dim The function calculates the dimension of a data object
calc_dim_type Calculates which dimensions that are used as row and col variables in data
checkForLevels Function to silently test for existence of metadata and return TRUE or FALSE based on the result of that test.
clean_pxweb Clean raw data from PX-WEB
create_batch_list The function takes an url and a dims object and calculates if this needs to be downloaded in batches due to download limit restrictions in the pxweb api. If '*' is used it will get the numberof values for this dimension using a get_pxweb_metadata call.
deparseLevels Functions from sweSCB package that are not called anywhere (yet) but might be useful later Function to deparse an URL into its components.
download_pxweb Traverse node for query alternatives and download data.
getContent Get content from response
get_dim_size The function calculates the dimension of a query. That means the numberof categories for each variable downloaded
get_pxweb_data Get data from a bottom node in PX-WEB API
get_pxweb_dims Get data dimensions form a bottom node in SCB API
get_pxweb_levels Get levels from API node
get_pxweb_metadata Get data
interactive_pxweb Find and download data interactively from PX-WEB API
print.api_parameters Print method for api_parameters.
pxweb pxweb
test_pxweb_api Test a full or a part of an pxweb api.
test_pxweb_api_get_data Download data for each bottom node in the pxweb api
test_pxweb_api_get_nodes Get the whole node tree from a given pxweb api
test_pxweb_api_get_node_metadata Get metadata from all bottom nodes identified with test_pxweb_api_get_nodes.