Generate summary report of analysis — generate

The function generates a report from a template. For the moment it only works for dwelling extracted from BD Topo.

Usage

generate_report(
  origin,
  destination = origin,
  archive,
  quiet = TRUE,
  template = "dwelling",
  complete = FALSE,
  purge = FALSE,
  verbose = TRUE
)

Arguments

origin: character, path to the directory where archive are stored.
destination: character, path to the directory where output should be saved.
archive: either a list with the information to display in the report or a vector of rds filenames containing compressed lists to be processed.
quiet: logical, should rmarkdown::render() be quiet or not.
template: character, either a keyword or the file name for the template to be used.
complete: logical, should the report be complete or synthetic.
purge: logical, should existing template in destination be removed and, so, a copy from original template in library be copied.
verbose: logical, should the function send some messages while running.

Author

David Nortes Martinez