Description Usage Arguments Value Examples
View source: R/compute.volume.frequency.analysis.R
Performs a volume frequency analysis on annual statistics similar to HEC-SSP.
1 2 3 4 5 6 7 8 9 10 11 12 13 | compute.volume.frequency.analysis(Station.Code, flow, start.year = 9999,
end.year = 0, use.water.year = FALSE, roll.avg.days = c(1, 3, 7, 15, 30,
60, 90), use.log = FALSE, use.max = FALSE,
prob.plot.position = c("weibull", "median", "hazen"),
prob.scale.points = c(0.9999, 0.999, 0.99, 0.9, 0.5, 0.2, 0.1, 0.02, 0.01,
0.001, 1e-04), fit.distr = c("PIII", "weibull"),
fit.distr.method = ifelse(fit.distr == "PIII", "MOM", "MLE"),
fit.quantiles = c(0.975, 0.99, 0.98, 0.95, 0.9, 0.8, 0.5, 0.2, 0.1, 0.05,
0.01), na.rm = list(na.rm.global = TRUE), write.stat.csv = TRUE,
write.stat.trans.csv = TRUE, write.plotdata.csv = FALSE,
write.quantiles.csv = TRUE, write.quantiles.trans.csv = TRUE,
write.frequency.plot = TRUE, write.frequency.plot.suffix = c("pdf",
"png"), report.dir = ".", csv.nddigits = 3, debug = FALSE)
|
Station.Code |
A character string. Used to name any *.csv or *.pdf files created so be careful that the Station.Code will be acceptable in a file name. |
flow |
Dataframe with two variables (1) Missing values for The date range of A water year runs from 1 October of the previous year to 30 Sept of the current year All other variables in the data frame will be ignored. Data does NOT have to be sorted by Date order. |
start.year, end.year |
Starting and ending year for statistics in YYYY format, e.g. start.year=2013. |
use.water.year |
Should results be computed on the water year (starting 1 October)? The 2013/2014 water year runs from 2013-10-01 to 2014-09-30. |
roll.avg.days |
Volume frequency analysis conducted on these rolling averages. |
use.log |
Transfrom to log-scale before analysis? |
use.max |
Analyze the maximums rather than the minimums. |
prob.plot.position |
Which plotting positions should be used in the frequency plots. Points are plotted
against (i-a)/(n+1-a-b) where |
prob.scale.points |
What points should be plotted along the $X$ axis in the frequency plot. |
fit.distr |
Which distribution should be fit? PIII = Pearson Log III distribution; weibull=Weibull distribution. |
fit.distr.method |
Which method used to fit the distribution. MOM=Method of moments; MLE=maximum likelihood estimation. |
fit.quantiles |
Which quantiles should be estimated from the fitted distribution? |
na.rm |
List of logical values indicating how to deal with missing values.
|
write.stat.csv |
Should a file be created with the computed percentiles?
The file name will be |
write.stat.trans.csv |
Should a file be created with the computed percentiles in transposed format?
The file name will be |
write.plotdata.csv |
Should a file be created with the frequency plot data?
The file name will be |
write.quantiles.csv |
Should a file be created with the fitted quantiles?.
The file name will be |
write.quantiles.trans.csv |
Should a file be created with the (transposed) fitted quantiles?
The file name will be |
write.frequency.plot |
Should a file be created with the frequency plot..
The file name will be |
write.frequency.plot.suffix |
Format of the frequency plot. |
report.dir |
Directory in which *.csv or *.pdf files are stored. |
csv.nddigits |
Number of decimal digits to be rounded to when creating *.csv files. |
debug |
Internal flag used for debugging |
A list with the following elements:
Q.flow.summary |
Data frame with flow summary. |
start.year |
Start year of the analysis |
end.year |
End year of the analysis |
use.water.year |
Were computations done on water year? |
use.max |
Were computations done on maximum values. |
roll.avg.days |
Rolling average days on which statistics computed. |
Q.stat |
Data frame with Computed annual summary statistics used in analysis |
Q.stat.trans |
Data frame with Computed annual summary statistics (transposed) used in analysis. |
plotdata |
Data frame with Co-ordinates used in frequency plot. |
prob.plot.position |
Which plotting position was used in frequency plot? |
freqplot |
ggplot2 object with frequency plot |
fit.distr |
Which distribution was fit to the data |
fit |
List of fitted objects from fitdistrplus. |
fitted.quantiles |
Data frame with fitted quantiles. |
fitted.quantiles.trans |
Data frame with fitted quantiles (transposed) |
file.stat.csv |
Object with file name of *.csv file with flow summary |
file.stat.trans.csv |
Object with file name of *.csv file with flow summary (transposed) |
file.plotdata.csv |
Object with file name of *.csv file with plotting information for frequency plot. |
file.quantile.csv |
Object with file name of fitted quantiles. |
file.quantile.trans.csv |
Object with file name of fitted quantiles (transposed) |
file.frequency.plot |
Object with file name of *.pdf or *.png file with frequency plot |
Version |
Version of this function. |
Date |
Date function was run. |
1 2 3 4 5 6 7 8 | ## Not run:
vfa.analysis <- compute.volume.frequency.analysis(
Station.Code ='XXX',
flow =flow,
start.year =1960,
end.year =2014)
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.