Return valid query parameters
Usage
pip_valid_params(
endpoint = c("all", "aux", "pip", "pip-grp", "pip-info", "valid-params"),
release_version = NULL,
ppp_version = NULL,
version = NULL
)Arguments
- endpoint
(
character(1)) endpoint for which valid parameters are to be returned. Default"all".- release_version
(
character(1)) version of the data release in YYYYMMDD format. DefaultNULL.- ppp_version
(
character(1)|numeric(1)) version of the data. DefaultNULL.- version
(
character(1)) version of the data. DefaultNULL.
Value
A data.frame() with the valid parameters.
See also
Other poverty and inequality statistics:
pip_aux(),
pip_citation(),
pip_data(),
pip_group(),
pip_health_check(),
pip_info(),
pip_versions()
Examples
# \donttest{
pip_valid_params()
#> param_names param_values param_boundaries param_types
#> 1 country ALL <NA> character
#> 2 country AFE <NA> character
#> 3 country AFW <NA> character
#> 4 country AGO <NA> character
#> 5 country ALB <NA> character
#> 6 country ARE <NA> character
#> 7 country ARG <NA> character
#> 8 country ARM <NA> character
#> 9 country AUS <NA> character
#> 10 country AUT <NA> character
#> 11 country AZE <NA> character
#> 12 country BDI <NA> character
#> 13 country BEL <NA> character
#> 14 country BEN <NA> character
#> 15 country BFA <NA> character
#> 16 country BGD <NA> character
#> 17 country BGR <NA> character
#> 18 country BIH <NA> character
#> 19 country BLR <NA> character
#> 20 country BLZ <NA> character
#> 21 country BOL <NA> character
#> 22 country BRA <NA> character
#> 23 country BRB <NA> character
#> 24 country BTN <NA> character
#> 25 country BWA <NA> character
#> 26 country CAF <NA> character
#> 27 country CAN <NA> character
#> 28 country CHE <NA> character
#> 29 country CHL <NA> character
#> 30 country CHN <NA> character
#> 31 country CIV <NA> character
#> 32 country CMR <NA> character
#> 33 country COD <NA> character
#> 34 country COG <NA> character
#> 35 country COL <NA> character
#> 36 country COM <NA> character
#> 37 country CPV <NA> character
#> 38 country CRI <NA> character
#> 39 country CYP <NA> character
#> 40 country CZE <NA> character
#> 41 country DEU <NA> character
#> 42 country DJI <NA> character
#> 43 country DNK <NA> character
#> 44 country DOM <NA> character
#> 45 country DZA <NA> character
#> 46 country EAP <NA> character
#> 47 country ECA <NA> character
#> 48 country ECU <NA> character
#> 49 country EGY <NA> character
#> 50 country ESP <NA> character
#> 51 country EST <NA> character
#> 52 country ETH <NA> character
#> 53 country FIN <NA> character
#> 54 country FJI <NA> character
#> 55 country FRA <NA> character
#> 56 country FSM <NA> character
#> 57 country GAB <NA> character
#> 58 country GBR <NA> character
#> 59 country GEO <NA> character
#> 60 country GHA <NA> character
#> 61 country GIN <NA> character
#> 62 country GMB <NA> character
#> 63 country GNB <NA> character
#> 64 country GNQ <NA> character
#> 65 country GRC <NA> character
#> 66 country GRD <NA> character
#> 67 country GTM <NA> character
#> 68 country GUY <NA> character
#> 69 country HND <NA> character
#> 70 country HRV <NA> character
#> 71 country HTI <NA> character
#> 72 country HUN <NA> character
#> 73 country IDN <NA> character
#> 74 country IND <NA> character
#> 75 country IRL <NA> character
#> 76 country IRN <NA> character
#> 77 country IRQ <NA> character
#> 78 country ISL <NA> character
#> 79 country ISR <NA> character
#> 80 country ITA <NA> character
#> 81 country JAM <NA> character
#> 82 country JOR <NA> character
#> 83 country JPN <NA> character
#> 84 country KAZ <NA> character
#> 85 country KEN <NA> character
#> 86 country KGZ <NA> character
#> 87 country KIR <NA> character
#> 88 country KOR <NA> character
#> 89 country LAC <NA> character
#> 90 country LAO <NA> character
#> 91 country LBN <NA> character
#> 92 country LBR <NA> character
#> 93 country LCA <NA> character
#> 94 country LKA <NA> character
#> 95 country LSO <NA> character
#> 96 country LTU <NA> character
#> 97 country LUX <NA> character
#> 98 country LVA <NA> character
#> 99 country MAR <NA> character
#> 100 country MDA <NA> character
#> 101 country MDG <NA> character
#> 102 country MDV <NA> character
#> 103 country MEX <NA> character
#> 104 country MHL <NA> character
#> 105 country MKD <NA> character
#> 106 country MLI <NA> character
#> 107 country MLT <NA> character
#> 108 country MMR <NA> character
#> 109 country MNA <NA> character
#> 110 country MNE <NA> character
#> 111 country MNG <NA> character
#> 112 country MOZ <NA> character
#> 113 country MRT <NA> character
#> 114 country MUS <NA> character
#> 115 country MWI <NA> character
#> 116 country MYS <NA> character
#> 117 country NAM <NA> character
#> 118 country NER <NA> character
#> 119 country NGA <NA> character
#> 120 country NIC <NA> character
#> 121 country NLD <NA> character
#> 122 country NOR <NA> character
#> 123 country NPL <NA> character
#> 124 country NRU <NA> character
#> 125 country OHI <NA> character
#> 126 country PAK <NA> character
#> 127 country PAN <NA> character
#> 128 country PER <NA> character
#> 129 country PHL <NA> character
#> 130 country PNG <NA> character
#> 131 country POL <NA> character
#> 132 country PRT <NA> character
#> 133 country PRY <NA> character
#> 134 country PSE <NA> character
#> 135 country QAT <NA> character
#> 136 country ROU <NA> character
#> 137 country RUS <NA> character
#> 138 country RWA <NA> character
#> 139 country SAS <NA> character
#> 140 country SDN <NA> character
#> 141 country SEN <NA> character
#> 142 country SLB <NA> character
#> 143 country SLE <NA> character
#> 144 country SLV <NA> character
#> 145 country SRB <NA> character
#> 146 country SSA <NA> character
#> 147 country SSD <NA> character
#> 148 country STP <NA> character
#> 149 country SUR <NA> character
#> 150 country SVK <NA> character
#> 151 country SVN <NA> character
#> 152 country SWE <NA> character
#> 153 country SWZ <NA> character
#> 154 country SYC <NA> character
#> 155 country SYR <NA> character
#> 156 country TCD <NA> character
#> 157 country TGO <NA> character
#> 158 country THA <NA> character
#> 159 country TJK <NA> character
#> 160 country TKM <NA> character
#> 161 country TLS <NA> character
#> 162 country TON <NA> character
#> 163 country TTO <NA> character
#> 164 country TUN <NA> character
#> 165 country TUR <NA> character
#> 166 country TUV <NA> character
#> 167 country TWN <NA> character
#> 168 country TZA <NA> character
#> 169 country UGA <NA> character
#> 170 country UKR <NA> character
#> 171 country URY <NA> character
#> 172 country USA <NA> character
#> 173 country UZB <NA> character
#> 174 country VEN <NA> character
#> 175 country VNM <NA> character
#> 176 country VUT <NA> character
#> 177 country WLD <NA> character
#> 178 country WSM <NA> character
#> 179 country XKX <NA> character
#> 180 country YEM <NA> character
#> 181 country ZAF <NA> character
#> 182 country ZMB <NA> character
#> 183 country ZWE <NA> character
#> 184 region AFE <NA> character
#> 185 region AFW <NA> character
#> 186 region ALL <NA> character
#> 187 region EAP <NA> character
#> 188 region ECA <NA> character
#> 189 region LAC <NA> character
#> 190 region MNA <NA> character
#> 191 region OHI <NA> character
#> 192 region SAS <NA> character
#> 193 region SSA <NA> character
#> 194 region WLD <NA> character
#> 195 year all <NA> character
#> 196 year MRV <NA> character
#> 197 year 1963 <NA> character
#> 198 year 1964 <NA> character
#> 199 year 1965 <NA> character
#> 200 year 1966 <NA> character
#> 201 year 1967 <NA> character
#> 202 year 1968 <NA> character
#> 203 year 1969 <NA> character
#> 204 year 1970 <NA> character
#> 205 year 1971 <NA> character
#> 206 year 1972 <NA> character
#> 207 year 1973 <NA> character
#> 208 year 1974 <NA> character
#> 209 year 1975 <NA> character
#> 210 year 1976 <NA> character
#> 211 year 1977 <NA> character
#> 212 year 1978 <NA> character
#> 213 year 1979 <NA> character
#> 214 year 1980 <NA> character
#> 215 year 1981 <NA> character
#> 216 year 1982 <NA> character
#> 217 year 1983 <NA> character
#> 218 year 1984 <NA> character
#> 219 year 1985 <NA> character
#> 220 year 1986 <NA> character
#> 221 year 1987 <NA> character
#> 222 year 1988 <NA> character
#> 223 year 1989 <NA> character
#> 224 year 1990 <NA> character
#> 225 year 1991 <NA> character
#> 226 year 1992 <NA> character
#> 227 year 1993 <NA> character
#> 228 year 1994 <NA> character
#> 229 year 1995 <NA> character
#> 230 year 1996 <NA> character
#> 231 year 1997 <NA> character
#> 232 year 1998 <NA> character
#> 233 year 1999 <NA> character
#> 234 year 2000 <NA> character
#> 235 year 2001 <NA> character
#> 236 year 2002 <NA> character
#> 237 year 2003 <NA> character
#> 238 year 2004 <NA> character
#> 239 year 2005 <NA> character
#> 240 year 2006 <NA> character
#> 241 year 2007 <NA> character
#> 242 year 2008 <NA> character
#> 243 year 2009 <NA> character
#> 244 year 2010 <NA> character
#> 245 year 2011 <NA> character
#> 246 year 2012 <NA> character
#> 247 year 2013 <NA> character
#> 248 year 2014 <NA> character
#> 249 year 2015 <NA> character
#> 250 year 2016 <NA> character
#> 251 year 2017 <NA> character
#> 252 year 2018 <NA> character
#> 253 year 2019 <NA> character
#> 254 year 2020 <NA> character
#> 255 year 2021 <NA> character
#> 256 year 2022 <NA> character
#> 257 year 2023 <NA> character
#> 258 year 2024 <NA> character
#> 259 year 2025 <NA> character
#> 260 povline 0 min numeric
#> 261 povline 2700 max numeric
#> 262 popshare 0 min numeric
#> 263 popshare 1 max numeric
#> 264 fill_gaps TRUE <NA> logical
#> 265 fill_gaps FALSE <NA> logical
#> 266 aggregate TRUE <NA> logical
#> 267 aggregate FALSE <NA> logical
#> 268 long_format TRUE <NA> logical
#> 269 long_format FALSE <NA> logical
#> 270 exclude TRUE <NA> logical
#> 271 exclude FALSE <NA> logical
#> 272 additional_ind TRUE <NA> logical
#> 273 additional_ind FALSE <NA> logical
#> 274 group_by none <NA> character
#> 275 group_by wb <NA> character
#> 276 welfare_type all <NA> character
#> 277 welfare_type consumption <NA> character
#> 278 welfare_type income <NA> character
#> 279 reporting_level all <NA> character
#> 280 reporting_level national <NA> character
#> 281 reporting_level rural <NA> character
#> 282 reporting_level urban <NA> character
#> 283 ppp 0.05 min numeric
#> 284 ppp 1e+06 max numeric
#> 285 version 20250401_2021_01_02_PROD <NA> character
#> 286 version 20250401_2017_01_02_PROD <NA> character
#> 287 version 20240627_2017_01_02_PROD <NA> character
#> 288 version 20240627_2011_02_02_PROD <NA> character
#> 289 version 20240326_2017_01_02_PROD <NA> character
#> 290 version 20240326_2011_02_02_PROD <NA> character
#> 291 version 20230919_2017_01_02_PROD <NA> character
#> 292 version 20230919_2011_02_02_PROD <NA> character
#> 293 version 20230328_2017_01_02_PROD <NA> character
#> 294 version 20230328_2011_02_02_PROD <NA> character
#> 295 version 20220909_2017_01_02_PROD <NA> character
#> 296 version 20220909_2011_02_02_PROD <NA> character
#> 297 format json <NA> character
#> 298 format csv <NA> character
#> 299 format rds <NA> character
#> 300 format arrow <NA> character
#> 301 table aux_versions <NA> character
#> 302 table countries <NA> character
#> 303 table country_coverage <NA> character
#> 304 table country_list <NA> character
#> 305 table cpi <NA> character
#> 306 table decomposition <NA> character
#> 307 table dictionary <NA> character
#> 308 table framework <NA> character
#> 309 table gdp <NA> character
#> 310 table incgrp_coverage <NA> character
#> 311 table indicators <NA> character
#> 312 table interpolated_means <NA> character
#> 313 table metaregion <NA> character
#> 314 table missing_data <NA> character
#> 315 table national_poverty_lines <NA> character
#> 316 table pce <NA> character
#> 317 table pg_lnp <NA> character
#> 318 table pg_svy <NA> character
#> 319 table pop <NA> character
#> 320 table pop_region <NA> character
#> 321 table poverty_lines <NA> character
#> 322 table ppp <NA> character
#> 323 table region_coverage <NA> character
#> 324 table regions <NA> character
#> 325 table spr_lnp <NA> character
#> 326 table spr_svy <NA> character
#> 327 table survey_means <NA> character
#> 328 cum_welfare 0 min numeric
#> 329 cum_welfare 1 max numeric
#> 330 cum_population 0 min numeric
#> 331 cum_population 1 max numeric
#> 332 requested_mean 0 min numeric
#> 333 requested_mean 1e+10 max numeric
#> 334 mean 0 min numeric
#> 335 mean 1e+10 max numeric
#> 336 times_mean 0.01 min numeric
#> 337 times_mean 5 max numeric
#> 338 lorenz lb <NA> character
#> 339 lorenz lq <NA> character
#> 340 n_bins 0 min numeric
#> 341 n_bins 1000 max numeric
#> 342 endpoint all <NA> character
#> 343 endpoint aux <NA> character
#> 344 endpoint pip <NA> character
#> 345 endpoint pip-grp <NA> character
#> 346 endpoint pip-info <NA> character
#> 347 endpoint valid-params <NA> character
#> 348 type both <NA> character
#> 349 type rg <NA> character
#> 350 type fg <NA> character
#> 351 pass RAC4De1m <NA> character
#> 352 version 20250401_2021_01_02_PROD <NA> character
#> 353 version 20250401_2017_01_02_PROD <NA> character
#> 354 version 20240627_2017_01_02_PROD <NA> character
#> 355 version 20240627_2011_02_02_PROD <NA> character
#> 356 version 20240326_2017_01_02_PROD <NA> character
#> 357 version 20240326_2011_02_02_PROD <NA> character
#> 358 version 20230919_2017_01_02_PROD <NA> character
#> 359 version 20230919_2011_02_02_PROD <NA> character
#> 360 version 20230328_2017_01_02_PROD <NA> character
#> 361 version 20230328_2011_02_02_PROD <NA> character
#> 362 version 20220909_2017_01_02_PROD <NA> character
#> 363 version 20220909_2011_02_02_PROD <NA> character
# }