wpCPRPopulation: wpCPRPopulation function to get a toptal population based on...

Description Usage Arguments Value Examples

View source: R/wpCPRPopulation.R

Description

wpCPRPopulation function to get a toptal population based on shapefile

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
wpCPRPopulation(
  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. If filename does not exist, the file is created.

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

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

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