Changelog
Source:NEWS.md
pixieweb 0.1.0
Initial CRAN release.
Documentation
- Improved quickstart vignette: explains ContentsCode, elimination,
_textcolumns, and adds inline ggplot comments. - Improved introduction vignette: navigation help, clearer elimination explanation, “Advanced features” marker, and motivation for codelists/wide output/query composition/saved queries.
- Improved multi-api vignette: honest framing of cross-country challenges, guidance on finding comparable tables, actionable tips, and cross-references.
- Fixed Unicode
≤inprepare_query()documentation that caused LaTeX PDF manual errors.
Features
-
API connection:
px_api()creates reusable connection objects for any PX-Web API (SCB, SSB, Statistics Finland, etc.) with automatic version detection (v1/v2). -
API availability:
px_available()performs a lightweight connectivity check, used to guard examples and tests. -
Table discovery:
get_tables()searches and lists available tables with support for both v1 (tree-walking) and v2 (search endpoint) APIs. -
Variable inspection:
get_variables()retrieves variable metadata for any table, including value lists and selection types. -
Data retrieval:
get_data()downloads data with automatic query construction, chunking for large requests, and rate limiting. -
Codelists:
get_codelists()retrieves codelist metadata;codelist_values()andcodelist_describe()for inspection. -
Selection helpers:
px_all(),px_top(),px_bottom(),px_from(),px_to(),px_range()for concise variable selections. -
Query workflow:
prepare_query()for interactive query building;compose_table_query(),compose_data_query(),execute_query()for programmatic access. -
Saved queries:
save_query()andget_saved_query()for persisting and reloading query specifications. -
Table helpers:
table_search(),table_describe(),table_enrich(),table_minimize(),table_extract_ids()for working with table metadata. -
Variable helpers:
variable_search(),variable_describe(),variable_minimize(),variable_extract_ids(),variable_name_to_code(),variable_values()for working with variables. -
Data helpers:
data_minimize(),data_comments(),data_legend()for working with downloaded data. -
Persistent caching:
pixieweb_cache_dir()andpixieweb_clear_cache()for managing cached API responses usingtools::R_user_dir(). -
Citations:
px_cite()generates citations for downloaded data. - HTTP resilience: Automatic retry with exponential backoff for transient errors and rate limiting (HTTP 429).
- Built-in API catalogue: Ships with a catalogue of known PX-Web APIs for Nordic and European statistical agencies.