Analyse dwellings in the BD Topo v3 reporting some elementary results

The function performs several analysis in order to check the validity and the consistency of the calculations made by functions extract_building() and extract_dwelling() over the BD Topo (version 3). The function focuses by default on residential constructions. In addition to returning a list, the function creates tables in csv format and png image files in path.

Usage

analyse_dwelling(
  origin,
  destination = gsub("building", "dwelling", origin),
  archive,
  category = "Résidentiel",
  dwelling_mean_surf = (90 * 1.2),
  report = TRUE,
  retrieve = TRUE,
  verbose = TRUE
)

Arguments

origin: character, path to the directory where archive are stored.
destination: character, path to the directory where output should be saved. The function expects it to be the same provided to function. extract_dwelling() if it has been previously invoked in the analysis. Default to same path as origin but substituting automatically keyword 'building' by keyword 'dwelling' when possible
archive: character, vector of filenames to be processed. If missing, analyse_dwelling is recursively called on all admissible archives found in origin.
category: character, focus of the analysis. Default to "Résidentiel".
dwelling_mean_surf: numeric, average surface of a dwelling in France. Default to 90 m^2, which is from adapted to the GT AMC's methodology.
report: logical, should the function create a summary report with the outputs. Default to TRUE.
retrieve: logical, should the output of the function be returned.
verbose: logical, should the function send some messages while running.

Value

A list of analysis if 'retrieve = TRUE'.

Author

David Nortes Martinez et Frédéric Grelot

Examples

if (FALSE) {

# calling function. Long version
   tab_building = analyse_dwelling(
       archive = "bdtopo-building-2022-03-15-D034.rds",
       origin = path_building,
       destination = path_dwelling,
       category = "Résidentiel",
       vintage = "2022-03-15"
   )

# calling function. short version
   tab_building = analyse_dwelling(
       archive = "bdtopo-building-2022-03-15-D034.rds",
       origin = path_building,
       destination = path_dwelling
   )

# calling function. recursive version
   analyse_dwelling(origin = path_building)
}