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