wpCPRDemographic: wpCPRDemographic function to get a toptal subnational...

In wpgp/wpCPR: An R package to submit a custom polygon request to the WorldPop API

Description

wpCPRDemographic function to get a toptal subnational population age-sex structures based on shapefile

Usage

wpCPRDemographic(
  year = 2000,
  shapeFilePath = NULL,
  outputFilePath = NULL,
  apikey = NULL,
  callbacktime = 5,
  maxexectime = 3600,
  apiurl = NULL,
  verbose = FALSE
)

Arguments

year	The year of the population (2000-2020)
shapeFilePath	The path to the shpaefile
outputFilePath	The opath to the output CVS file
apikey	API key to access the WorldPop API
callbacktime	Default is 5 sec. TIme to call the API server
maxexectime	Default is 3600 sec. Max execution time of the request.
apiurl	URL to WorldPop API
verbose	If TRUE then the progress will be shown

Value

DataFrame* object

Examples

wpCPRDemographic(year=2013, shapeFilePath = file.path("/tmp/Inputs/BFA-HDX-Borders.shp"))
	

wpgp/wpCPR documentation built on April 2, 2021, 9:49 a.m.