pxweb: R Interface to the PX-Web/PC-Axis API
Version 0.6.3

Generic interface for the PX-Web/PC-Axis API. The PX-Web/PC-Axis API is used by organizations such as Statistics Sweden and Statistics Finland to disseminate data. The R package can interact with all PX-Web/PC-Axis APIs to fetch information about the data hierarchy, extract metadata and extract and parse statistics to R data.frame format. PX-Web is a solution to disseminate PC-Axis data files in dynamic tables on the web. Since 2013 PX-Web contains an API to disseminate PC-Axis files.

Browse man pages Browse package API and functions Browse package files

AuthorMans Magnusson, Leo Lahti, Love Hansson
Date of publication2016-12-05 18:28:48
MaintainerMans Magnusson <mons.magnusson@gmail.com>
LicenseBSD_2_clause + file LICENSE
Version0.6.3
URL https://github.com/rOpenGov/pxweb/
Package repositoryView on CRAN
InstallationInstall the latest version of this package by entering the following in R:
install.packages("pxweb")

Man pages

api_catalogue: Get the api catalogue
api_parameters: Return options for database, version and language choices
api_timer: Creates a timer that keeps track of how many calls that has...
base_url: Return base URL to API
buildPath: Build a path from character elements
calc_dim_type: Calculates which dimensions that are used as row and col...
calculate_data_dim: The function calculates the dimension of a data object
checkForLevels: Function to silently test for existence of metadata and...
check_new_pxweb_apis: Check and compare differences between remote and local api...
choose_pxweb_api: Choose an api from api_catalogue
choose_pxweb_database_url: Calculate a specific database to get data from
clean_pxweb: Clean raw data from PX-WEB
create_batch_list: The function takes an url and a dims object and calculates if...
deparseLevels: Functions from sweSCB package that are not called anywhere...
download_pxweb: Traverse node for query alternatives and download data.
findData.input: Get input that is consistent with
get_api_index: Get index of which api has the name or teh alias
get_api_list: Get the api catalogue from json file
get_api_list_remote: Get the api catalogue from github
getContent: Get content from response
get_dim_size: The function calculates the dimension of a query. That means...
get_github_api_urls: Get (hard coded) api catalogue github urls
get_pxweb_data: Get data from a bottom node in PX-WEB API
get_pxweb_dims: Get data dimensions form a bottom node in a PX-Web/PC-Axis...
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
pxweb_api-class: A Reference Class to represent an pxweb_api
reorder_and_check_dims: Reorders the dimensions of a 'get_pxweb_data()' call and...
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_node_metadata: Get metadata from all bottom nodes identified with...
test_pxweb_api_get_nodes: Get the whole node tree from a given pxweb api
text_to_url: Change text to url
update_pxweb_apis: Download and update the PXWEB API catalogue
write_api_list: Write api catalogue to json file

Functions

api_catalogue Man page Source code
api_parameters Man page Source code
api_timer Man page Source code
base_url Man page Source code
buildPath Man page Source code
calc_dim_type Man page Source code
calculate_data_dim Man page Source code
checkForLevels Man page Source code
check_new_pxweb_apis Man page Source code
choose_pxweb_api Man page Source code
choose_pxweb_database_url Man page Source code
clean_pxweb Man page Source code
create_batch_list Man page Source code
deparseLevels Man page Source code
download_pxweb Man page Source code
findData.input Man page Source code
findData.inputBaseCat Source code
findData.inputConvert Source code
findData.printCode Source code
findData.printNode Source code
getContent Man page Source code
get_api_index Man page Source code
get_api_list Man page Source code
get_api_list_remote Man page Source code
get_dim_size Man page Source code
get_github_api_urls Man page Source code
get_pxweb_data Man page Source code
get_pxweb_dims Man page Source code
get_pxweb_levels Man page Source code
get_pxweb_metadata Man page Source code
interactive_pxweb Man page Source code
onAttach Source code
print.api_parameters Man page Source code
pxweb Man page
pxweb-package Man page
pxweb_api Man page
pxweb_api-class Man page
reorder_and_check_dims Man page Source code
test_pxweb_api Man page Source code
test_pxweb_api_get_data Man page Source code
test_pxweb_api_get_node_metadata Man page Source code
test_pxweb_api_get_nodes Man page Source code
text_to_url Man page Source code
update_pxweb_apis Man page Source code
write_api_list Man page Source code

Files

inst
inst/examples
inst/examples/ex_dimension_mining.R
inst/examples/ex_get_data.R
inst/examples/ex_data_mining.R
inst/examples/hierarchy.RData
inst/examples/ex_statfi_getdata.R
inst/examples/ex_time_tracking_graphs.R
inst/extras
inst/extras/build.cran.sh
inst/extras/document.R
inst/CITATION
inst/extdata
inst/extdata/api.json
inst/extdata/test_files
inst/extdata/test_files/responseTest.Rdata
inst/extdata/test_files/testFiles.Rdata
inst/doc
inst/doc/pxweb.Rmd
inst/doc/pxweb.md
inst/doc/pxweb.R
inst/doc/pxweb.html
tests
tests/testthat_api_base.R
tests/testthat_test_utils.R
tests/testthat_clean_pxweb.R
tests/testthat_get_pxweb.R
tests/testthat_pxweb_api_class.R
tests/testthat_pxweb_examples.R
tests/testthat_interactive.R
tests/testthat_multiple.R
tests/testthat_big_query.R
tests/testthat_api_catalogue.R
tests/testthat.R
tests/testthat_api_in_catalogue.R
tests/testthat
tests/testthat/test-pxweb_api_class.R
tests/testthat/test-interactive_pxweb.R
tests/testthat/test-big_query.R
tests/testthat/test-multiple_queries_data.R
tests/testthat/test-get_pxweb_data.R
tests/testthat/test-utils_internal.R
tests/testthat/test-clean_pxweb.R
tests/testthat/test-api_parameters.R
tests/testthat/test-test_pxweb_api.R
tests/testthat/test-api_catalogue.R
tests/testthat/test-get_pxweb_dims.R
tests/testthat/test-base_url.R
tests/testthat/test-get_pxweb_metadata.R
tests/testthat/test-pxweb_examples.R
tests/testthat/test-get_pxweb_levels.R
tests/testthat/test-apis_in_catalogue.R
tests/testthat_test_pxweb_api.R
NAMESPACE
R
R/api_catalogue.R
R/interactive_pxweb.R
R/get_pxweb_metadata.R
R/utils_internal.R
R/interactive_pxweb_internal.R
R/base_url.R
R/get_pxweb_levels.R
R/get_pxweb_dims.R
R/get_pxweb_data_internal.R
R/test_pxweb_api_internal.R
R/get_pxweb_data.R
R/test_pxweb_api.R
R/pxweb_api_class.R
R/constants.R
R/todo.R
R/api_parameters.R
R/firstlib.R
R/pxweb.R
vignettes
vignettes/pxweb.Rmd
MD5
build
build/vignette.rds
DESCRIPTION
man
man/choose_pxweb_database_url.Rd
man/choose_pxweb_api.Rd
man/get_pxweb_dims.Rd
man/base_url.Rd
man/getContent.Rd
man/interactive_pxweb.Rd
man/pxweb.Rd
man/update_pxweb_apis.Rd
man/api_timer.Rd
man/clean_pxweb.Rd
man/check_new_pxweb_apis.Rd
man/api_catalogue.Rd
man/get_github_api_urls.Rd
man/create_batch_list.Rd
man/api_parameters.Rd
man/reorder_and_check_dims.Rd
man/test_pxweb_api_get_data.Rd
man/checkForLevels.Rd
man/get_pxweb_levels.Rd
man/test_pxweb_api_get_nodes.Rd
man/download_pxweb.Rd
man/text_to_url.Rd
man/test_pxweb_api.Rd
man/get_api_index.Rd
man/findData.input.Rd
man/get_api_list_remote.Rd
man/get_api_list.Rd
man/print.api_parameters.Rd
man/get_dim_size.Rd
man/get_pxweb_data.Rd
man/deparseLevels.Rd
man/calc_dim_type.Rd
man/pxweb_api-class.Rd
man/get_pxweb_metadata.Rd
man/write_api_list.Rd
man/calculate_data_dim.Rd
man/test_pxweb_api_get_node_metadata.Rd
man/buildPath.Rd
LICENSE
pxweb documentation built on May 19, 2017, 7:27 a.m.