AASHGS_Execute: A function to execute the ASHGS model

Description Usage Arguments Value

View source: R/AASHGS_Execute.R

Description

This function executes the at-a-station hydraulic geometry simulator, which is a method of determining weighted usable area. For more information about the theoretical component of this model see: McParland et al. (2016). At-a-station hydrualic geometry simulator. River Res. Applic. 32: 399 - 410. This function requires that the 'birk' package is loaded in your directory.

Usage

1
2
AASHGS_Execute(S, wb, db, db_max, max_Q, d_curve, v_curve,
  s_curve = NULL, D84, gsd = NULL)

Arguments

S

channel gradient (m/m)

wb

reach averaged bankfull width (m).

db

reach averaged bankfull depth (m).

db_max

Defaults to NULL. reach averaged maximum bankfull depth (m). Specifying db_max is preferred.

max_Q

maximum discharge (m3/s) to simualted WUA for. Defaults to simulated bankfull dsicharge.

d_curve

A dataframe of depth suitability curves with four columns as follows: column 1: "species" - This identified species (eg "species"); column 2: "life_stage" - This identifies life stage (eg "fry"); column 3: "depth" (m); column 4: "suit" (0 - 1)

v_curve

A dataframe of velocity suitability curves with four columns as follows: column 1: "species" - This identified species (eg "species"); column 2: "life_stage" - This identifies life stage (eg "fry"); column 3: "velocity" (m/s); column 4: "suit" (0 - 1)

s_curve

Defaults to NULL> A dataframe of substrate suitability curves with five columns as follows: column 1: "species" - This identified species (eg "species"); column 2: "life_stage" - This identifies life stage (eg "fry"); column 3: "lower" (mm) - This identifies the lower limit of each class; column 4: "upper" (mm) - This identifies the upper limit of each class; column 5: "suit" (0 - 1)

D84

grain size (mm)

gsd

Defaults to NULL. A dataframe of the grain size distribution with one column: individual grain sizes (mm). Intended for use with output of the Find_D84 function.

Value

.csv of hydraulic data

.csv of WUA suitability data 'suitability.csv'

.pdf figure of simulated cross section

.pdf figure of the WUA - Q curve AASHGS_Execute()


SGronsdahl/AASHGS documentation built on May 26, 2019, 4:38 p.m.