Skip to content

avertableburden/avert_report

Repository files navigation

avert_report: Generate a report from the avert computational model

DOI

This is the shell of a reporting template to be used in conjunction with the avert computational model.

This reporting template is designed for use in conjunction with the avert R library. You can install avert with the following commands.

utils::install.packages("remotes")

remotes::install_github("avertableburden/avert")

To render a report using the latest release of this template:

library(avert)
write_avert_report(get_input_data(), output_dir_1L_chr = tempdir())

Alternatively, if you clone this repository to your machine, you can render the latest development version of the template from within the parent directory of the cloned repository:

library(avert)
write_avert_report(get_input_data(), mkdn_source_dir_1L_chr = getwd(), output_dir_1L_chr = "Tests")

An example of a PDF report produced with the above calls is available for download here.

About

Initial shell of a reporting template to summarise output from the avert computational model

Resources

License

Stars

Watchers

Forks

Packages

No packages published