generate_report: Generate Report
In mkoohafkan/RAStestR: Functions for testing RAS outputs

Description Usage Arguments Details See Also Examples

Generate a RAStestR report.

1
2
3

generate_report(base.file, new.file, sections, standard.opts = list(),
  sediment.opts = list(), output.name, output.folder = tempdir(),
  output.type = c("html", "pdf"))

`base.file`	The path to the first or "base" RAS model HDF output.
`new.file`	The path to the second or "new" RAS model HDF output.
`sections`	The sections to include in the report.
`standard.opts`	List with elements `which.times` and `which.stations` specifying the times and stations to output for standard tables. See `read_standard` for details.
`sediment.opts`	List with elements `which.times`, `which.stations` and `which.grains` specifying the times, stations and grain classes to output for sediment tables. See `read_sediment` for details.
`output.name`	The output filename, without an extension.
`output.folder`	The folder to write out files to. Defaults to the R temporary directory.
`output.type`	The file type to generate, either "html" or "pdf".

Generating a report requires that the packages knitr, rmarkdown and ggplot2 are installed. The following sections can be included in a report:

dredged cum
effective depth
effective_width
flow
froude number channel
invert change
invert elevation
lat struc mass div
long. cum mass change
mannings n channel
mass bed change cum
mass in cum
mass out cum
mean effective invert change
mean effective invert elevation
sediment concentration
shear stress
slope
velocity
water surface
d10 active
d10 inactive
d50 active
d50 inactive
d90 active
d90 inactive

read_standard

read_sediment

## Not run: 
simple.quasi = system.file("sample-data/SampleQuasiUnsteady.hdf",
  package = "RAStestR")
generate_report(simple.quasi, simple.quasi, 
  sections = c("Flow", "Vol In Cum"),
  output.name = "test", output.type = "html")

## End(Not run)