summarise_dwelling.Rd
summarise_dwelling
creates a summary of information taht should
be for dwellings. It performs elementary statistics on how many buildings and
dwellings are included for a structured typlogy used inside the function.
summarise_dwelling(
origin,
destination = file.path(origin, "synthesis"),
archive,
flood = NULL,
graph = TRUE,
retrieve = FALSE,
verbose = TRUE
)
character, path to the directory where archive are stored.
character, path to the directory where results should be saved.
character, vector of archive to be summarised.
character, name of column that give it dwellings are in a flood area. This column should be of type logical.
logical, should graphs be plotted.
logical, should the result be returned.
logical, should the function give some sumup informations.
if retrieve = TRUE, data.frame of summarised data.
If the option flood is given, summarise_dwelling
first makes a
selection on this column before doing the analysis.
If the option graph is set to TRUE, summarise_dwelling
traces graphs
that represent how "wall", "roof", and "level" evolves in yerly based for
each type in "AB", "MFH", "TH", and "SH". Those graphs are saved with a
reference to "flood" if given, to be able to find for what selection those
graphs have been plotted. If "flood" is not given, the reference is "all".