analyse-bdtopo

Purpose of the functionality

To analyze the BD-topo, generating summary tables and graphs that enable the quick analysis of the information available for each French department as well as the detection of anomalies and artifacts

Functionnality added

• analyse_dwelling: function that generates tables, figures, and a list of information saved as a rds file to prepare report

  • The function does not count on runable examples
  • The function does not count on tests
  • The function takes as input the output of function extract_building() and extract_dwelling(). If the output of extract_dwelling() is not available, the function extract_dwelling() will be called inside analyse_dwelling()
  • The function's outputs are tables in csv format, figures in png format, and a list of information saved in rds format

• generate_report: function that generates a report in pdf using the output from analyse_dwelling()

  • The function does not count on runable examples
  • The function does not count on tests
  • The function takes as input the rds file from analyse_dwelling()
  • The function's outputs is a pdf document

• creation of function

  • code of function
  • documentation of function
  • example for function (non reproducible)

Data added

• bd_topo_nature_reclass: Scheme to rename levels of variable 'nature' in the BT TOPO version 3.0.
  • format: data.frame with 14 rows and 2 variables:
    • nature: character, name of categories originally used variable 'nature' of the BD Topo.
    • classification_fr: character, name of categories to be used to transform the categories in variable 'nature'
    • order: character, order of the level in the factor variable
• bd_topo_wall: Scheme to rename levels of variable 'material_wall' in the BT TOPO version 3.0
  • format A data frame with 64 rows and 4 variables:
    • material_wall: character, categories of materials.
    • label_wall_bdtopo: character, originally given name to the categories of materials in the BDTopo.
    • label_wall_fr: character, simplified name to the categories of materials in french
    • combined_wall: character, TRUE if two categories of materials are mixed
• bd_topo_roof: Scheme to rename levels of variable 'material_roof' in the BT TOPO version 3.0
  • format A data frame with 36 rows and 4 variables:
    • material_roof: character, categories of materials.
    • label_roof_bdtopo: character, originally given name to the categories of materials in the BDTopo.
    • label_roof_fr: character, simplified name to the categories of materials in french
    • combined_roof: character, TRUE if two categories of materials are mixed

Warning: To add data, there is a need to add script to allow maintenance of data

• brief description
  • source of the data
  • storage of the data (inst/extdata)
• creation of data
  • storage of raw data in ascii format, normally in inst/extdata
  • script in to maintain data in /data-raw
  • documentation of data