Man pages for rOpenGov/pxweb
R Interface to PXWEB APIs
| add_pxe_defaults | Add default values to pxe |
| api_catalogue | Defunct functions |
| as_pxweb_levels | Assert that x is a correct 'pxweb_database_list' object. |
| assert_pxweb | Assert that the url structure is correct |
| 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_data | Assert that x is a correct 'pxweb_data' object. |
| assert_pxweb_database_list | Assert that x is a correct 'pxweb_database_list' object. |
| assert_pxweb_data_comments | Assert that x is a correct 'pxweb_data_comments' object. |
| assert_pxweb_data_jsonstat | Assert that x is a correct 'pxweb_data_jsonstat' object.... |
| assert_pxweb_input_allowed | Assert a 'pxweb_input_allowed' object |
| assert_pxweb_levels | Assert that x is a correct 'pxweb_levels' object. |
| assert_pxweb_metadata | Assert that x is a correct 'pxweb_metadata' object. |
| assert_pxweb_query | Assert a pxweb_query object |
| assert_pxweb_rda_file_path | Assert that the rda_file_path is correct |
| assert_pxweb_url | Assert that the url structure is correct |
| assert_query_can_be_split_to_batches | Assert that a given pxweb query can be split |
| build_pxweb_config_url | Build the url to get the config from a PXWEB api |
| build_pxweb_rda_file_path | Build or get the tmp_rda_file_path from an url or... |
| build_pxweb_url | Build the url to a PXWEB api |
| generate_permutations | Generate batch permutations |
| http_was_redirected | http_was_redirected |
| is_pxweb_config_response | Check if a response is a pxweb config response |
| parse_url_or_fail | Parse a character string or throws error if it fails |
| permutations | Generate permutations of dimensions to find optimal no of... |
| print.pxweb_api_catalogue_entry | Print a catalogue entry |
| pxd_values_to_valuetexts | Convert a pxweb data objects values to valuetext |
| pxe_allowed_input | Defines allowed input for a position in a 'pxweb_explorer' or... |
| pxe_back_position | Move in the 'pxweb_explorer' position |
| pxe_data_url | Get the url to a table |
| pxe_handle_input | Handle a user input for a 'pxweb_explorer' object. |
| pxe_input | Get (allowed) inputs for a 'pxweb_input_allowed' object. |
| pxe_interactive_get_data | Ask to download and download data |
| pxe_metadata_choices | Get and set pxe_metadata_coices |
| pxe_metadata_variable_names | Get the meta data variable names from a 'pxweb_explorer'... |
| pxe_position_choice_size | How many choices has the current position? |
| pxe_position_is_api_catalogue | Is the current position an api_catalogue position? |
| pxe_position_is_full_query | Is the current position a full query (i.e. choices for all... |
| pxe_position_is_metadata | Is the current position a metadata object? |
| pxe_position_multiple_choice_allowed | Are multiple choices allowed? |
| pxe_position_title | Get the table title for the current position |
| pxe_position_variable_can_be_eliminated | Can the variable at the current position be eliminated? |
| pxe_print_download_code | Print code to download query |
| pxe_pxobj_at_position | Return the pxweb object at the current position |
| pxweb | S3 constructor for 'pxweb' api object. |
| pxweb_add_api_subpath | Add the subpath slot to a pxweb path slot |
| pxweb_add_call | Add an api call to a pxweb_api_s3 object |
| pxweb_add_config | Add the config slot to a pxweb object |
| pxweb_add_mandatory_variables | Add mandatory variables to query |
| pxweb_add_metadata_to_query | Add and remove metadata to query |
| pxweb_advanced_get | Do a GET call to PXWEB API for advanced users |
| pxweb_api_catalogue | Get the PXWEB API catalogue |
| pxweb_api_catalogue_entry | Constructor for 'pxweb_api_catalogue_entry'. |
| pxweb_api_name | Get the api name, rootpath, subpath, path or dbpath |
| pxweb_as_data_frame | Coerce a 'pxweb_data' object to a 'data.frame' |
| pxweb_as_json | Convert object to json |
| pxweb_c | Combine pxweb objects |
| pxweb_cite | Cite a PXWEB data object |
| pxweb_clear_cache | Clear cache of all (or one) 'pxweb' object |
| pxweb_data | Construct a 'pxweb_data' object. |
| pxweb_database_list | Construct a 'pxweb_database_list' object. |
| pxweb_data_c | Combine pxweb objects |
| pxweb_data_colnames | Get query filter |
| pxweb_data_column_comment | Construct a 'pxweb_data_comment' object |
| pxweb_data_comments | Construct a 'pxweb_data_comments' object. |
| pxweb_data_dim | Compute the dimension of the query 'pxweb_data' object |
| pxweb_data_jsonstat | Construct a 'pxweb_data_jsonstat' object. |
| pxweb_explorer | Create a 'pxweb_explorer' object. |
| pxweb_fix_url | Fix url characters |
| pxweb_get | Do a GET call to PXWEB API |
| pxweb_get_api_test_data_frame | Build api test data.frame |
| pxweb_get_data | Do a GET call to PXWEB API and return a data.frame |
| pxweb_http_log_on | Setup a structure to log all API calls |
| pxweb_interactive | Find and download data interactively from a PXWEB API |
| pxweb_interactive_input | Get input from user |
| pxweb_levels | Construct a 'pxweb_levels' object. |
| pxweb_metadata | Construct a 'pxweb_metadata' object. |
| pxweb_metadata_add_null_values | Add values to NULL value variables in PXWEB metadata objects |
| pxweb_metadata_dim | Compue the dimension of a metadata object |
| pxweb_metadata_elimination | Get boolean vector |
| pxweb_metadata_time | Get boolean vector |
| pxweb-package | Interface to PX-WEB APIs from R |
| pxweb_parse_response | Parse the response from a PXWEB API (advanced) |
| pxweb_query | Create a PXWEB query |
| pxweb_query_as_json | Convert a 'pxweb_query' object to a 'json' string |
| pxweb_query_as_rcode | Print a 'pxweb_query' object as R code |
| pxweb_query_dim | Compue the dimension of the query |
| pxweb_query_dim_splittable | Get vector indicating splittable variables |
| pxweb_query_filter | Get query values |
| pxweb_query_values | Get query filter |
| pxweb_split_query | Split query in optimal sub-queries |
| pxweb_tempdir | Setup temorary directory for the pxweb |
| pxweb_test_api | Test a full or a part of a PXWEB api. |
| pxweb_test_create_api_paths | Create all paths from a list of pxweb_api_catalogue entries |
| pxweb_test_time_limit | Test time limit object |
| pxweb_validate_query_with_metadata | Validate a 'pxweb_query' with a 'pxweb_metadata' object |
| save_pxweb | Save and load 'pxweb' objects from R temp folder |
| split_dimensions_left_right | Split variables into chunks |
| str_pad | Pad a string to a fixed size |
| str_trim | Taken from 'trimws' for reasons of compatibility with... |
