longitudinal_profile_report: Longitudinal Profile Report

In mpdougherty/razviz: A package to visualize performance of HEC-RAS models

Description

Create a Longitudinal Profile Report for the input RAS model.

Usage

longitudinal_profile_report(
  hydro_model,
  long_plot_pgs,
  gages,
  gage_labels_df,
  gage_boxes_df,
  high_water,
  levees,
  features,
  bridges,
  graph_colors,
  legend_labels,
  plot_labels,
  output_dir,
  filename
)

Arguments

hydro_model	data frame; A data frame of results from a RAS model. See the package dataset for required fields.
long_plot_pgs	data frame; A data frame of longitudinal plot pages produced by the 'razviz::long_plot_pages' function.
gages	data frame. A data frame of gages. See package dataset for required fields.
gage_labels_df	data frame; A data frame of gage labels produced by the 'razviz::gage_labels' function.
gage_boxes_df	data frame; A data frame of gage boxes produced by the 'razviz::gage_boxes' function.
high_water	data frame; A data frame of high water marks. See the package dataset for required fields.
levees	data frame; A data frame of levee elevations. See the package dataset for required fields.
features	data frame; A data frame of salient river features (e.g., tributary confluences, cities, bridges, dams, etc.). See package dataset for required fields.
bridges	data frame; A data frame of bridge opening elevations. See package dataset for required fields.
graph_colors	character vector; A named character vector of colors to use for each series.
legend_labels	character vector; A character vector of labels to be used in the legend.
plot_labels	list; A list of plot labeling elements. Must contain three named elements "title", "x_axis", and "y_axis".
output_dir	character; The path to the folder where the output report will be written.
filename	character; the pdf filename (must end in .pdf)

Value

A Longitudinal Profile Report in 'pdf' document format.

mpdougherty/razviz documentation built on April 1, 2021, 4:16 p.m.