sample_frame_summary: Sample Frame Summary Table

View source: R/sample_frame_summary.R

sample_frame_summaryR Documentation

Sample Frame Summary Table

Description

Produce a summary table of the sampling frame.

Usage

sample_frame_summary(
  strm = NA,
  constrained_strm = NA,
  roads = NA,
  stream_order = "STREAM_ORDER",
  summary_type = "stream_lengths"
)

Arguments

strm

A streamline data set of class sf from the BCFWA. Run utm_projection() first to ensure projection is in meters.

constrained_strm

A the constrained streamline data set of class sf. Generally this layer is produced as a derivative of the strm layer after constraining NCD, excluding lentic areas and removing alpine areas.

roads

A road network data set of class sf. Run utm_projection() first to ensure projection is in meters.

stream_order

String. Column name for stream order. Defaults to STREAM_ORDER. Rename as needed. Stream order is used to define the sampling strata.

summary_type

String. Which summary table should be produced? Options include stream_lengths for a summary of stream lengths by strata or stream_crossings for summary of stream crossings by strata. Rename as needed. Stream order is used to define the sampling strata.

Details

It can be convenient to produce a summary table of the entire sampling frame by strata. This function summarizes the total length of streams by strata and the total count of stream crossings by strata.

Value

A summary table according to the summary_type.


essatech/wsep.t2 documentation built on Sept. 3, 2022, 5:56 a.m.