get_fgp_allstations: Extracting flood generating process for a set of stations

Description Usage Arguments Value Examples

Description

Flood generating process is calculated as as the fraction of flood runoff casued by rain (0-1) for a set of stations and identified flood events. time series of catchment average rain and snow melt is extracted from the SeNorge model and is performed using the function 'extract_ams_allstations'. The recession times are calculated using 'extract_recessiontimes_allstations' See "get_fgp" for details

Usage

1
2
3
4
5
get_fgp_allstations(floodfile = "inst/Example_data/Flooddata/amsvalues.txt",
  rainfile = "inst/Example_data/klimadata/aveR.txt",
  snowfile = "inst/Example_data/klimadata/aveS.txt",
  recessionfile = "inst/Example_data/flooddata/recessiontimes.txt",
  outfile = "inst/Example_data/Flooddata/ams_and_fgp.txt", cfgp = 4)

Arguments

floodfile

File with the flood data. Created by the function 'extract_ams_allstations' or 'extract_pot_allstations'

rainfile

File with the rain data. Created by the function 'get_metdataforfloods'

snowfile

File with the snow melt data. Created by the function 'get_metdataforfloods'

recessionfile

File with recession times. Created by the function 'extract_recessiontimes_allstations'

outfile

File for storing the fgp. Similar to the input flood file, but with a colomn of fgp added.

cfgp

column where the fgp will be written.

Value

dataframe with floods where fgp is included. The data frame is also written to file.

Examples

1
2
3
get_fgp_allstations(floodfile='inst/Example_data/Flooddata/amsvalues.txt',rainfile='inst/Example_data/klimadata/aveR.txt',
snowfile='inst/Example_data/klimadata/aveS.txt',recessionfile='inst/Example_data/flooddata/recessiontimes.txt',
outfile='inst/Example_data/Flooddata/ams_and_fgp.txt')

NVE/NVEHYDROTOOLS documentation built on May 7, 2019, 6:04 p.m.