Changelog

Source: NEWS.md

pipapi 1.2.0

New features

• Add new endpoint to support country profile downloads
• Add separate arguments to select release and ppp version
• Allow direct selection of non-official WB regions
• Add new /citation endpoint

Enhancements

• Disable popshare option for pip_grp and aggregate distributions
• Allow /aux endpoint to return data in long format
• Make default poverty line dynamic in API

pipapi 1.1.0

Enhancements

• Sort the rows by country_code and reporting_year in the pip response.
• Fix casing making pip call case insensitive
• Add unit tests for newly created fg_remove_duplicates() and sub-functions
• auto convert parameters to their respective types in parse_parameters
• Sanitize user inputs in get_aux_table
• Removed purrr dependency
• Better error message when passing more than one dataset as lkup in pip call

New features

• Region codes can now be passed directly to the country query parameter to return all countries pertaining to the specified region
• the /valid-params endpoint gains an endpoint parameter that allows to only return parameters that are relevant to the specified endpoint
• Add /valid-years endpoint that returns available years for both survey and interpolated years
• Add direct selection for WLD aggregate

pipapi 1.0.0

New features

• Add /pip-grp as a new endpoint for aggregated statistics
• Soft deprecate group_by argument in /pip
• Change parameter version_length for vintage_pattern in extract_data_dirs(). The algorithm for extracting valid versions has been modified.
• Add option to enable disk based caching of pip() and pip_grp()
• Add asynchronous processing of slow API requests

Enhancements

• Increase maximum limit for povline parameter from 100 to 10 000
• Remove unnecessary columns from API response
• Add estimation_type and distribution_type to the API response when fill_gaps=TRUE
• Use pip_grp() to calculate aggregated statistics in UI functions; ui_hp_stacked() and ui_pc_regional()
• Add unit tests for pip_grp()
• Improve filtering of data version directories in create_versioned_lkups()
• Add country and region name to /pip response
• Make sure latest data version is available as a specific version (not just as “latest_relase”)
• Use fs functions rather than base R’s.

Bug fixes

• Duplicates are no longer created when fill_gaps=TRUE
• Add povline=NULL option for /cp-key-indicators endpoint. This fixes an issue with the UI ingestion.
• Fix bug where distributional stats were incorrectly returned as missing for extrapolated surveys when fill_gaps=TRUE
• Add reporting_level to the output of ui_cp_poverty_charts()
• Make sure ui_cp_poverty_charts() only returns non-national observations when a country has no surveys with national coverage
• Fix a bug in the application of censoring within pip_grp()
• Add a specific empty repsonse for pip_grp() to ensure that the response is consistent when no data is available
• Fix a bug in the selection of most recent value (year="MRV") when country="ALL"

pipapi 0.0.1

Initial release of the API that powered the PIP soft-launch on February 9, 2022

pipapi 0.0.0.9000

• Added a NEWS.md file to track changes to the package.