Learn R Programming

pxweb (version 0.17.0)

R Interface to PXWEB APIs

Description

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.

Copy Link

Version

Install

install.packages('pxweb')

Monthly Downloads

1,069

Version

0.17.0

License

BSD_2_clause + file LICENSE

Issues

Pull Requests

Stars

Forks

Repository

https://github.com/rOpenGov/pxweb/

Homepage

https://ropengov.github.io/pxweb/

Maintainer

Last Published

January 29th, 2024

Functions in pxweb (0.17.0)

is_pxweb_config_response

Check if a response is a pxweb config response

assert_pxweb_database_list

Assert that x is a correct pxweb_database_list object.

pxe_metadata_variable_names

Get the meta data variable names from a pxweb_explorer object.

pxweb_as_data_frame

Coerce a pxweb_data object to a data.frame

Convert object to json

pxe_metadata_choices

Get and set pxe_metadata_coices

pxweb_add_config

Add the config slot to a pxweb object

pxe_position_multiple_choice_allowed

Are multiple choices allowed?

pxe_position_title

Get the table title for the current position

pxweb_advanced_get

Do a GET call to PXWEB API for advanced users

pxe_allowed_input

Defines allowed input for a position in a pxweb_explorer or character object.

Get the url to a table

pxe_handle_input

Handle a user input for a pxweb_explorer object.

pxe_back_position

Move in the pxweb_explorer position

Add an api call to a pxweb_api_s3 object

pxe_position_is_metadata

Is the current position a metadata object?

pxe_pxobj_at_position

Return the pxweb object at the current position

Interface to PX-WEB APIs from R

pxweb_api_catalogue

Get the PXWEB API catalogue

Compute the dimension of the query pxweb_data object

pxe_position_is_full_query

Is the current position a full query (i.e. choices for all metadata variables)?

assert_pxweb_input_allowed

Assert a pxweb_input_allowed object

pxweb_data_column_comment

Construct a pxweb_data_comment object

pxweb_interactive

Find and download data interactively from a PXWEB API

generate_permutations

Generate batch permutations

parse_url_or_fail

Parse a character string or throws error if it fails

pxweb_http_log_on

Setup a structure to log all API calls

Get (allowed) inputs for a pxweb_input_allowed object.

build_pxweb_url

Build the url to a PXWEB api

pxweb_data_jsonstat

Construct a pxweb_data_jsonstat object.

pxe_interactive_get_data

Ask to download and download data

Construct a pxweb_levels object.

pxe_position_variable_can_be_eliminated

Can the variable at the current position be eliminated?

Generate permutations of dimensions to find optimal no of batches

pxweb_add_mandatory_variables

Add mandatory variables to query

pxweb_query_dim_splittable

Get vector indicating splittable variables

pxe_print_download_code

Print code to download query

pxweb_split_query

Split query in optimal sub-queries

Combine pxweb objects

pxd_values_to_valuetexts

Convert a pxweb data objects values to valuetext

print.pxweb_api_catalogue_entry

Print a catalogue entry

pxweb_interactive_input

Get input from user

pxweb_query_values

Get query filter

pxweb_query_filter

Get query values

pxweb_add_metadata_to_query

Add and remove metadata to query

pxweb_database_list

Construct a pxweb_database_list object.

Create a pxweb_explorer object.

S3 constructor for pxweb api object.

pxe_position_choice_size

How many choices has the current position?

pxe_position_is_api_catalogue

Is the current position an api_catalogue position?

pxweb_add_api_subpath

Add the subpath slot to a pxweb path slot

pxweb_query_as_rcode

Print a pxweb_query object as R code

pxweb_api_catalogue_entry

Constructor for pxweb_api_catalogue_entry.

Cite a PXWEB data object

pxweb_validate_query_with_metadata

Validate a pxweb_query with a pxweb_metadata object

pxweb_data_comments

Construct a pxweb_data_comments object.

Taken from trimws for reasons of compatibility with previous R versios.

Do a GET call to PXWEB API

pxweb_query_dim

Compue the dimension of the query

split_dimensions_left_right

Split variables into chunks

Combine pxweb objects

Fix url characters

Construct a pxweb_data object.

Pad a string to a fixed size

Get the api name, rootpath, subpath, path or dbpath

pxweb_query_as_json

Convert a pxweb_query object to a json string

pxweb_data_colnames

Get query filter

pxweb_test_create_api_paths

Create all paths from a list of pxweb_api_catalogue entries

Create a PXWEB query

pxweb_clear_cache

Clear cache of all (or one) pxweb object

Construct a pxweb_metadata object.

pxweb_test_time_limit

Test time limit object

Save and load pxweb objects from R temp folder

pxweb_metadata_time

Get boolean vector

pxweb_metadata_add_null_values

Add values to NULL value variables in PXWEB metadata objects

pxweb_parse_response

Parse the response from a PXWEB API (advanced)

pxweb_get_api_test_data_frame

Build api test data.frame

Test a full or a part of a PXWEB api.

Do a GET call to PXWEB API and return a data.frame

pxweb_metadata_dim

Compue the dimension of a metadata object

Setup temorary directory for the pxweb

pxweb_metadata_elimination

Get boolean vector

add_pxe_defaults

Add default values to pxe

build_pxweb_url.url

Build the url to get the config from a PXWEB api

Assert that the url structure is correct

Defunct functions

as_pxweb_levels

Assert that x is a correct pxweb_database_list object.

assert_pxweb_data

Assert that x is a correct pxweb_data object.

assert_pxweb_data_comments

Assert that x is a correct pxweb_data_comments object.

build_pxweb_rda_file_path

Build or get the tmp_rda_file_path from an url or pxweb_api_s3 object

assert_pxweb_query

Assert a pxweb_query object

assert_pxweb_data_jsonstat

Assert that x is a correct pxweb_data_jsonstat object. Assert a json-stat version 1.0 or later object

assert_pxweb_api_catalogue

Assert a pxweb_api_catalogue object

assert_pxweb_calls

Assert that the rda_file_path is correct

assert_pxweb_config

Assert that the config slot is correct

assert_pxweb_rda_file_path

Assert that the rda_file_path is correct

assert_pxweb_levels

Assert that x is a correct pxweb_levels object.

http_was_redirected

http_was_redirected

assert_pxweb_url

Assert that the url structure is correct

assert_pxweb_metadata

Assert that x is a correct pxweb_metadata object.

assert_query_can_be_split_to_batches

Assert that a given pxweb query can be split