The goal of seinebasin2 is to modelling the Seine River basin with the airGRiwrm package.
It has been developed to produce the studies described in these reports:
“En attente de création de rapport”
“IN-WOP project WP3 - Seine River study case: Risk-based management rules
Installation
You can install the development version of seinebasin2 like so:
install.packages("remotes")
::install_gitlab("in-wop/seinebasin2", host = "gitlab.irstea.fr", dependencies = TRUE) remotes
Documentation
See the “Reference” section for a documentation of the functions included in this package.
Render the reports
Run the script dev/render_book.R
to render all the reports at once. By default, reports are generated in HTML format in the folder public/reports
. The script can be called from the root of the package or from the dev subdirectory.
The call syntax is:
/renderbook.R [--cleancache] OUTPUT_FORMAT [REPORT1] [REPORT...] Rscript dev
With: - --cleancache
: optional argument for cleaning chunk caches before rendering the reports, - OUTPUT_FORMAT
: Output format of the reports which should be bookdown::gitbook
for an HTML report or bookdown::pdf_book
for a PDF report, - REPORT1
, REPORT...
: folder name of a selected reports to render by default all reports located in the reports
are render. If this argument is used, the OUTPUT_FORMAT
argument must be defined.
For example the following command line will generate the first report in PDF:
/renderbook.R bookdown::pdf_book 01-naturalized_flows_CC_impact Rscript dev
Requirements
The package tinytex
needs to be installed for PDF generation.
install.packages("tinytex")
::install_tinytex() tinytex
Known issues
Getting error message “pandoc version 1.12.3 or higher is required and was not found” when rendering the reports outside of Rstudio.
Try the solution proposed by https://stackoverflow.com/questions/28432607/pandoc-version-1-12-3-or-higher-is-required-and-was-not-found-r-shiny