generate_report: Generate Report

Description Usage Arguments Details See Also Examples

View source: R/report.r

Description

Generate a RAStestR report.

Usage

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"))

Arguments

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".

Details

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

See Also

read_standard

read_sediment

Examples

1
2
3
4
5
6
7
8
## 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)

mkoohafkan/RAStestR documentation built on July 14, 2019, 11:41 p.m.