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

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.

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
https://github.com/rOpenGov/pxweb/

View on CRAN

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

Files in this package

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

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

All documentation is copyright its authors; we didn't write any of that.