buildXSectionPlot

Builds the combined map + stacked cross-section figure and writes it to a PDF. Cross-section points are colored by their stage zone (height above the channel relative to stageLevels).

buildXSectionPlot(
  transectObject,
  plotFileName = "test.png",
  returnData = TRUE,
  verticalCutoff = 4,
  streamDir = NULL,
  ...
)

Arguments

transectObject

Object created by generateCrossSections, after addCrossSectionElevations has run.

plotFileName

Output PDF path.

returnData

Logical (TRUE); return the transectObject.

verticalCutoff

Cross-section points more than this many meters above/below the channel are trimmed from the plot.

streamDir

Optional stream shapefile path drawn on the map panel.

...

Ignored (accepted so pipeline wrappers can pass shared arguments through).

Value

transectObject with $XSectionPlot and $XSectionPlotData added.