This repository has been archived by the owner on Oct 13, 2022. It is now read-only.
/
hysep.Rd
56 lines (49 loc) · 1.69 KB
/
hysep.Rd
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/hysep.R
\name{hysep}
\alias{hysep}
\title{Baseflow Separation}
\usage{
hysep(Flow, Dates, Start = NULL, End = NULL, da, select = "sliding",
STAID = "Unknown")
}
\arguments{
\item{Flow}{the daily streamflow to be separated missing values are not permitted
within the time specified by \code{Start} and \code{end}.}
\item{Dates}{the date for each \code{x}, should be of class "Date." Missing values
are not permitted.}
\item{Start}{the start date for the analysis, can be either a character string or
class "Date."}
\item{End}{the end date for the analysis, can be either a character string or
class "Date."}
\item{da}{the drainage area of the basin in square miles.}
\item{select}{a character string indicating which method to use for the
baseflow in the output dataset. Must be one of "sliding," "local minimum,"
or "fixed." Onle the first letter is required.}
\item{STAID}{the station identifier for the data.}
}
\value{
an object of class "baseflow" and inherits class "data.frame" of the selected data,
a data frame of the baseflow information, and other information about the analysis.
}
\description{
Extract baseflow from a daily streamflow record using the method described by
Sloto and Crouse (1996).
}
\examples{
\dontrun{
library(smwrData)
data(ChoptankFlow)
# Process by calendar year as that is the retrieval range
ChopPart <- with(ChoptankFlow, hysep(Flow, datetime, da=113,
STAID="01491000"))
ChopPart
}
}
\references{
Sloto, R.A. and Crouse, M.Y., 1996, HYSEP:
A COMPUTER PROGRAM FOR STREAMFLOW HYDROGRAPH SEPARATION AND ANALYSIS:
U.S. geological Survey Water-Resources Investigations
Report 96-4040. 46 p.
}
\keyword{baseflow}