ms_separate_baseflow: Calculate baseflow

View source: R/ms_separate_baseflow.R

ms_separate_baseflowR Documentation

Calculate baseflow

Description

Use the Lynne-Hollick baseflow filter, via hydrostats, to perform baseflow separation

Usage

ms_separate_baseflow(discharge, alpha = 0.975, n.reflected = 30)

Arguments

discharge

data.frame. A MacroSheds discharge table of one site

alpha

Numeric. Default 0.975, alpha value for the Lynne-Hollick baseflow filter. See details for more information.

n.reflected

Numeric. Default 30, see hydrostats::baseflow documentation for more information.

Details

This function uses the Lynne-Hollick baseflow filter to separate baseflow and stormflow. The underlying package hydrostats is used for this calculation. Additional information on alpha values and n.reflected can be found using ?hydrostats::baseflows

Value

returns a discharge data.frame in MacroSheds format with the added column of "baseflow"

Author(s)

Spencer Rhea

Mike Vlah, vlahm13@gmail.com

Wes Slaughter

Examples

q = macrosheds::ms_load_product(
    macrosheds_root = 'my/ms/root/',
    prodname = 'discharge',
    domains = 'hbef')
ms_separate_baseflow(q)

MacroSHEDS/macrosheds documentation built on Oct. 30, 2024, 11:15 a.m.