Download BAN
download_ban.Rd
downlaod_ban()
is used has a wrapper of download_archive()
to download
easily BAN database.
Arguments
- destination
character, the address where data are stocked.
- repository
character, keyword or the repository from where data are downloaded. Best to use given options. See details.
- origin
character, url address from where data are downloaded. It is set when repository is something else than "other".
- extension
character, vector of acceptable types of archive to be downloaded.
- date
character, date of the archive to be downloaded.
- version
string, version of BAN to be downloaded. See details.
- department
integer, or converted to integer. Departments that should be considered. See details.
- region
integer, or converted to integer. Regions that should be considered. See details.
- verbose
logical, should the function send some messages while running.
Details
If repository
is set to "data.gouv", then all necessary variables are
filled with those values:
origin is set to "https://adresse.data.gouv.fr/data/ban/adresses"
name default value is changed to "adresses"
extension default value is changed to "csv.gz"
date default value is used to choose a given directory. If date is
NULL
, then the most recent version is taken (equivalent to "latest").version must be something within "ban" or "bal". When "ban" is used the file with one position per address is used. When "bal" is used, the file with several position per address is used.
department is used. Should be admissible French departments (a formatting will be attempted with
format_scope()
). IfNULL
, region may be used. If both areNULL
, all departments from `floodam.data::department`` will be used.region may be used if department is
NULL
. Should be admissible French regions (a formatting will be attempted withformat_scope()
). If region is given and department isNULL
, all departments from given region will be used.
If repository
is set to "other", everything shall be filled so that
download_archive()
can make a successful download.