-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path2-5-Reports.qmd
More file actions
129 lines (88 loc) · 19.2 KB
/
2-5-Reports.qmd
File metadata and controls
129 lines (88 loc) · 19.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# Reports
FluvialGeomorph produces a series of reports that help to define stream conditions.
### `Graph - Longitudinal Profile Compare` {#longitudinal-profile-compare-graph}
This graph is produced using the [`Graph - Longitudinal Profile Compare`](#longitudinal-profile-compare-graph-tool) tool.
```{r echo=FALSE, fig.cap="Longitudinal Profile Plot.", out.width="100%"}
knitr::include_graphics("figures/toolbox/Graph-Longitudinal_Profile_Compare.png")
```
### `Report - L1` {#L1-report}
**Purpose** - The Level 1 Report contains a set of maps and graphs that describe the channel as measured from the LiDAR derived DEM. This report is produced using the [`Report - L1`](#L1-report-tool) tool using these instructions from the [user manual](https://fluvialgeomorph.github.io/FG-User-Manual/level-1-workflow.html#run-report).
**Code** - This report is created by the [R Markdown parameterized report](https://bookdown.org/yihui/rmarkdown/parameterized-reports.html) in the R package [`fluvgeo/reports/level_1_report.Rmd`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/inst/reports/level_1_report.Rmd).
This report contains the following sections:
* **Study Area Overview** - This section provides an overview of the study area reach.
* Reach Overview Map - A reach overview map displaying cross section locations over an aerial image and/or a medium resolution DEM with multi-direction shaded relief. This figure is produced by the R function [`fluvgeo::map_reach_overview`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/map_reach_overview.R).
* **Longitudinal Profile** - This section displays the elevation (y-axis) of the stream reach along its length (x-axis) beginning from the downstream end of the reach moving upstream (typically referred to as a longitudinal profile).
* Longitudinal Profile - This longitudinal profile graph is created from the [`flowline_points`](#flowline-points-fc) feature class for several surveys if available. This figure is produced by the R function [`fluvgeo::compare_long_profile.R`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/compare_long_profile.R).
* XS Longitudinal Profile - This longitudinal profile graph is created using a [regular cross sections](#regular-xs-fc) feature class. This figure is produced by the R function [`fluvgeo::compare_xs_long_profile`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/compare_xs_long_profile.R).
* **Cross Section Metrics** - This section displays metrics for the cross sections of a stream reach.
* Cross Section Metrics Plot, Level 1 - This stream reach metrics graph displays the Level 1 metrics on a faceted graph. This figure is produced by the R function [`fluvgeo::xs_metrics_plot_L1`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/xs_metrics_plot_L1.R).
* **Cross Section Profiles** - This section displays a focused view of the characteristics of each individual cross section in the stream reach.
* Cross Section Map - This map displays the extent of a single cross section in plan view with a DEM background. This figure is produced by the R function [`fluvgeo::map_xs`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/map_xs.R).
* Cross Section Profile Compare Plot - This graph displays a single regularly spaced cross section in profile view comparing the elevations from multiple surveys if provided. This figure is produced by the R function [`fluvgeo::xs_compare_plot_L1`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/xs_compare_plot_L1.R).
```{r echo=FALSE, fig.cap="Level 1 Report.", out.width="100%"}
knitr::include_graphics("figures/toolbox/Report_L1.png")
```
### `Report - L2 Estimate Bankfull` {#estimate-bankfull-report}
**Purpose** - The Estimate Bankfull Report is used to help estimate the bankfull water surface elevation for an ungaged stream with the assistance of regional curves and visual observation of geomorphic indicators from LiDAR surveys. This report is produced using the [`Report - L2 Estimate Bankfull`](#estimate-bankfull-report-tool) tool using these instructions from the [user manual](https://fluvialgeomorph.github.io/FG-User-Manual/level-2-workflow.html#estimate-bankfull).
**Code** - This report is created by the [R Markdown parameterized report](https://bookdown.org/yihui/rmarkdown/parameterized-reports.html) in the R package [`fluvgeo/reports/estimate_bankfull_report.Rmd`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/inst/reports/estimate_bankfull_report.Rmd).
This report contains the follow sections:
* **Study Area Overview** - This section provides an overview of the study area reach.
* Reach Overview Map - A reach overview map displaying cross section locations over an aerial image and/or a medium resolution DEM with multi-direction shaded relief. This figure is produced by the R function [`fluvgeo::map_reach_overview`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/map_reach_overview.R).
* **Bankfull Elevation Sensitivity Analysis** - This section performs a sensitivity analysis of the directly measured reach-wide channel dimensions compared to the regional curve estimated channel dimensions.
* Bankfull Elevation Goodness of Fit Graph - This graph is used to identify how similar this reach's dimensions are compared to dimensions from several other regions at the current bankfull estimate. This figure is produced by the R function [`fluvgeo::gof_graph`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/gof_graph.R).
* Bankfull Elevation Dimensions by Region Table - This table summarizes this reach's dimensions compared to several other regions at the current bankfull elevation. This table is created by code in the Estimate Bankfull Report, [`fluvgeo/reports/estimate_bankfull_report.Rmd`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/inst/reports/estimate_bankfull_report.Rmd)
* Regional Hydraulic Geometry Curves Graph - This graph displays the channel dimensions of each cross section in the reach, along with the regional curve estimated dimensions. This figure is produced by the R function [`fluvgeo::reach_rhg_graph`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/reach_rhg_graph.R).
* **Longitudinal Profile** - This section displays the elevation (y-axis) of the stream reach along its length (x-axis) beginning from the downstream end of the reach moving upstream (typically referred to as a longitudinal profile).
* XS Longitudinal Profile - This longitudinal profile graph is created using a [`riffle_channel`](#riffle-xs-fc) feature class for the survey used to generate the bankfull estimate. This figure is produced by the R function [`fluvgeo::xs_profile_plot`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/xs_profile_plot.R).
* **Cross Section Metrics** - This section displays metrics the Level 2 metrics for the riffle cross sections of a stream reach.
* Cross Section Metrics Plot, Level 2 - This stream reach metrics graph displays the Level 2 metrics on a faceted graph. This figure is produced by the R function [`fluvgeo::xs_metrics_plot_L2`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/xs_metrics_plot_L2.R).
* **Cross Section Profiles** - This section displays a focused view of the characteristics of each individual cross section in the stream reach.
* Cross Section Map - This map displays the extent of a single cross section in plan view with a high resolution DEM background. This figure is produced by the R function [`fluvgeo::map_xs`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/map_xs.R).
* Floodplain XS Profile Compare Plot - This graph displays a single `riffle_floodplain` feature in a wide aspect ratio profile view to compare the elevations from multiple surveys if provided. This figure is produced by the R function [`fluvgeo::xs_compare_plot_L2`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/xs_compare_plot_L2.R).
* Channel XS Profile Compare Plot - This graph displays a single `riffle_channel` feature in a square aspect ratio profile view to compare the elevations from multiple surveys if provided. This figure is produced by the R function [`fluvgeo::xs_compare_plot_L2`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/xs_compare_plot_L2.R).
* Bankfull Elevation Dimensions by Region Table - This table summarizes this cross section's dimensions compared to several other regions at the current bankfull elevation. This table is created by code in the Estimate Bankfull Report, [`fluvgeo/reports/estimate_bankfull_report.Rmd`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/inst/reports/estimate_bankfull_report.Rmd).
```{r echo=FALSE, fig.cap="Level 2, Estimate Bankfull Report.", out.width="100%"}
knitr::include_graphics("figures/toolbox/Report_L2_Estimate_Bankfull.png")
```
### `Report - L2` {#L2-report}
**Purpose** - The Level 2 Report contains a set of maps and graphs that describe the Level 2 channel dimensions calculated at the specified bankfull elevation, estimated using the [L2 Estimate Bankfull Report](#estimate-bankfull-report). This report is produced using the [`Report - L2`](#L2-report-tool) tool using these instructions from the [user manual](https://fluvialgeomorph.github.io/FG-User-Manual/level-2-workflow.html#run-report-1).
**Code** - This report is created by the [R Markdown parameterized report](https://bookdown.org/yihui/rmarkdown/parameterized-reports.html) in the R package [`fluvgeo/reports/level_2_report.Rmd`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/inst/reports/level_2_report.Rmd).
This report contains the following sections:
* **Study Area Overview** - This section provides an overview of the study area reach.
* Reach Overview Map - A reach overview map displaying cross section locations over an aerial image and/or a medium resolution DEM with multi-direction shaded relief. This figure is produced by the R function [`fluvgeo::map_reach_overview`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/map_reach_overview.R).
* **Longitudinal Profile** - This section displays the elevation (y-axis) of the stream reach along its length (x-axis) beginning from the downstream end of the reach moving upstream (typically referred to as a longitudinal profile).
* XS Longitudinal Profile - This longitudinal profile graph is created using a [Level 2 cross section dimensions](#xs-dimensions-fc) feature class for the survey used to generate the bankfull estimate. This figure is produced by the R function [`fluvgeo::xs_profile_plot`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/xs_profile_plot.R).
* **Cross Section Metrics** - This section displays metrics for the Level 2 dimensions calculated for the regular cross sections of a stream reach.
* Cross Section Metrics Plot, Level 2 - This stream reach metrics graph displays the Level 2 metrics on a faceted graph. This figure is produced by the R function [`fluvgeo::xs_metrics_plot_L2`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/xs_metrics_plot_L2.R).
* Width Depth Ratio Map - A reach overview map is used to display the width depth ratio values at each cross section for the reach. The width depth ratio parameters (i.e., metric definition, class break values and labels) are defined in this report using the R S4 class [`FluvialGeomorphicMetric`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/FluvialGeomorphicMetric.R). This figure is produced by the R function [`fluvgeo::map_reach_metric`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/map_reach_metric.R).
* Width Depth Ratio Graph - This graph displays the width depth ratio values (y-axis) of the stream along its length (x-axis) beginning from the downstream end of the reach moving upstream longitudinally. This graph uses the metric class definition for width depth ratio defined for the previous figure. This figure is produced by the R function [`fluvgeo::xs_metric_plot`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/xs_metric_plot.R).
* Regional Hydraulic Geometry Curves Graph - This graph displays the channel dimensions of each cross section in the reach, along with the regional curve estimated dimensions. This figure is produced by the R function [`fluvgeo::reach_rhg_graph`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/reach_rhg_graph.R).
* **Cross Section Profiles** - This section displays a focused view of the characteristics of each individual cross section in the stream reach.
* Cross Section Map - This map displays the extent of a single cross section in plan view with a high resolution DEM background. This figure is produced by the R function [`fluvgeo::map_xs`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/map_xs.R).
* Regular XS Profile Compare Plot - This graph displays a single `*_L2_dims` feature in a wide aspect ratio profile view to compare the elevations from multiple surveys if provided. This figure is produced by the R function [`fluvgeo::xs_compare_plot_L2`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/xs_compare_plot_L2.R).
* Bankfull Elevation Dimensions by Region Table - This table summarizes this cross section's dimensions compared to several other regions at the current bankfull elevation. This table is created by code in the L2 Report, [`fluvgeo/reports/level_2_report.Rmd`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/inst/reports/level_2_report.Rmd).
```{r echo=FALSE, fig.cap="Level 2 Report.", out.width="100%"}
knitr::include_graphics("figures/toolbox/Report_L2.png")
```
### `Report - L3` {#L3-report}
**Purpose** - The Level 3 Report contains a set of maps and graphs that describe the Level 3 channel dimensions calculated at the specified bankfull elevation, estimated using the [L2 Estimate Bankfull Report](#estimate-bankfull-report). This report is produced using the [`Report - L3`](#L3-report-tool) tool using these instructions from the [user manual](https://fluvialgeomorph.github.io/FG-User-Manual/level-3-workflow.html#run-report-2).
**Code** - This report is created by the [R Markdown parameterized report](https://bookdown.org/yihui/rmarkdown/parameterized-reports.html) in the R package [`fluvgeo/reports/level_3_report.Rmd`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/inst/reports/level_3_report.Rmd).
This report contains the following sections:
* **Study Area Overview** - This section provides an overview of the study area reach.
* Reach Overview Map - A reach overview map displaying cross section locations over an aerial image and/or a medium resolution DEM with multi-direction shaded relief. This figure is produced by the R function [`fluvgeo::map_reach_overview`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/map_reach_overview.R).
* **Longitudinal Profile** - This section displays the elevation (y-axis) of the stream reach along its length (x-axis) beginning from the downstream end of the reach moving upstream (typically referred to as a longitudinal profile).
* XS Longitudinal Profile - This longitudinal profile graph is created using a [Level 3 cross section dimensions](#xs-dimensions-fc) feature class for the survey used to generate the bankfull estimate. This figure is produced by the R function [`fluvgeo::xs_profile_plot`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/xs_profile_plot.R).
* **Cross Section Metrics** - This section displays metrics for the Level 3 dimensions calculated for the regular cross sections of a stream reach.
* Cross Section Metrics Plot, Level 3 - This stream reach metrics graph displays the Level 3 metrics on a faceted graph. This figure is produced by the R function [`fluvgeo::xs_metrics_plot_L3`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/xs_metrics_plot_L3.R).
* Width Depth Ratio Map - A reach overview map is used to display the width depth ratio values at each cross section for the reach. The width depth ratio parameters (i.e., metric definition, class break values and labels) are defined in this report using the R S4 class [`FluvialGeomorphicMetric`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/FluvialGeomorphicMetric.R). This figure is produced by the R function [`fluvgeo::map_reach_metric`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/map_reach_metric.R).
* Width Depth Ratio Graph - This graph displays the width depth ratio values (y-axis) of the stream along its length (x-axis) beginning from the downstream end of the reach moving upstream longitudinally. This graph uses the metric class definition for width depth ratio defined for the previous figure. This figure is produced by the R function [`fluvgeo::xs_metric_plot`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/xs_metric_plot.R).
* Radius of Curvature to Bankfull Width Map - A reach overview map is used to display the radius of curvature to bankfull width ratio values at each cross section for the reach. The radius of curvature to bankfull width ratio parameters (i.e., metric definition, class break values and labels) are defined in this report using the R S4 class [`FluvialGeomorphicMetric`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/FluvialGeomorphicMetric.R). This figure is produced by the R function [`fluvgeo::map_reach_metric`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/map_reach_metric.R).
* Radius of Curvature to Bankfull Width Graph - This graph displays the radius of curvature to bankfull width ratio values (y-axis) of the stream along its length (x-axis) beginning from the downstream end of the reach moving upstream longitudinally. This graph uses the metric class definition for radius of curvature to bankfull width ratio defined for the previous figure. This figure is produced by the R function [`fluvgeo::xs_metric_plot`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/xs_metric_plot.R).
* Regional Hydraulic Geometry Curves Graph - This graph displays the channel dimensions of each cross section in the reach, along with the regional curve estimated dimensions. This figure is produced by the R function [`fluvgeo::reach_rhg_graph`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/reach_rhg_graph.R).
* **Cross Section Profiles** - This section displays a focused view of the characteristics of each individual cross section in the stream reach.
* Cross Section Map - This map displays the extent of a single cross section in plan view with a high resolution DEM background. This figure is produced by the R function [`fluvgeo::map_xs`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/map_xs.R).
* Regular XS Profile Compare Plot - This graph displays a single `*_L3_dims` feature in a wide aspect ratio profile view to compare the elevations from multiple surveys if provided. This figure is produced by the R function [`fluvgeo::xs_compare_plot_L2`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/R/xs_compare_plot_L2.R).
* Bankfull Elevation Dimensions by Region Table - This table summarizes this cross section's dimensions compared to several other regions at the current bankfull elevation. This table is created by code in the L3 Report, [`fluvgeo/reports/level_3_report.Rmd`](https://github.com/FluvialGeomorph/fluvgeo/blob/master/inst/reports/level_3_report.Rmd).
```{r echo=FALSE, fig.cap="Level 3 Report.", out.width="100%"}
knitr::include_graphics("figures/toolbox/Report_L3.png")
```