Skip to contents

Generate data from BD-Topo-dwelling for the so-ii communes

generate_db_typology.Rd

The function extracts the data from the the BD-Topo-dwelling created by the R library floodam.data for the so-ii communes. Then it summarizes the data and creates the database that serves as input for the analysis "Typologie des bâtiments résidentiels sur le territoire so-ii" available in the so-ii website

Usage

generate_db_typology(dataset, vintage, path, retrieve = FALSE)

Arguments

dataset

data from BD-Topo-dwelling. See details.

vintage

edition (as date) of the BD-Topo® used in dataset.

path

character, the name of the file to save the plot. Graphical device is chosen depending on extension.

retrieve

logical, should the result be returned?. default to FALSE

Value

subject to the value of parameter retrieve:

  • FALSE (default): the function does not return an object. It stores the database (csv.gz file) and the metadata (yml file) in path.

  • TRUE: the function returns a list with two slots, one for the data (as data.frame) and one for the metadata (as character). It also stores the database (csv.gz file) and the metadata (yml file) in path.

Details

A workflow integrating libraries floodam.data and so-ii is proposed in the so-ii website We strongly recomend to visit the web page and follow the steps described there.

Examples


if (FALSE) { # \dontrun{
# To be added (soon)
} # }