longitudinal_profile_plot: Longitudinal Profile Plot

Description Usage Arguments Value

View source: R/longitudinal_profile_plot.R

Description

Creates a longitudinal profile graph for the hydraulic parameter named 'hydro_parameter'.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
longitudinal_profile_plot(
  plot_number,
  hydro_model,
  long_plot_pgs,
  levee_smooth = FALSE,
  graph_colors,
  legend_labels,
  plot_labels,
  ...,
  levees,
  gages,
  gage_labels_df,
  gage_boxes_df,
  high_water,
  features,
  bridges
)

Arguments

plot_number

numeric; The plot number to graph.

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.

levee_smooth

logical; Draw a smoothed levee line? (Default FALSE)

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

levees

See the data frame; Optional data frame of levee elevations. package dataset for required fields.

gages

data frame. Optional data frame of gages. See package dataset for required fields.

high_water

data frame; Optional data frame of high water marks. See the package dataset for required fields.

features

data frame; Optional data frame of salient river features (e.g., tributary confluences, cities, bridges, dams, etc.). See package dataset for required fields.

bridges

data frame; Optional data frame of bridge opening elevations. See package dataset for required fields.

gage_labels

data frame; Optional data frame of gage labels produced by the 'razviz::gage_labels' function.

gage_boxes

data frame; Optional data frame of gage boxes produced by the 'razviz::gage_boxes' function.

Value

A 'ggplot2' object depicting the river longitudinal profile graph.


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