Description Usage Arguments Value Examples
View source: R/compute.Q.percentile.longterm.R
Computes many percentiles on the flow$Q
variable
between start.year
and end.year
inclusive for both calendar and water years.
It (optionally) saves the results in *.csv and *.pdf files.
1 2 3 4 5 6 | compute.Q.percentile.longterm(Station.Code = "XXXXX", flow,
start.year = 9999, end.year = 0, per.list = c(1, 2, seq(5, 95, 5), 98,
99), write.cy.stat.csv = TRUE, write.cy.stat.trans.csv = TRUE,
write.wy.stat.csv = TRUE, write.wy.stat.trans.csv = TRUE,
report.dir = ".", csv.nddigits = 3, na.rm = list(na.rm.global = TRUE),
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. |
per.list |
Percentiles to be computed |
write.cy.stat.csv |
Should a file be created with the computed calendar year percentiles?
The file name will be |
write.cy.stat.trans.csv |
Should a file be created with the transposed of the calendar year percentile report?
The file name will be |
write.wy.stat.csv |
Should a file be created with the computed water year percentiles?
The file name will be |
write.wy.stat.trans.csv |
Should a file be created with the transposed of the water year percentile report?
The file name will be |
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. |
na.rm |
List of logical values indicating how to deal with missing values.
|
debug |
Internal flag used for debugging |
A list with the following elements:
Q.cy.percentile.stat |
Data frame with the calendar year percentiles of |
Q.cy.percentile.stat.trans |
Data frame with the calendar year percentiles of |
file.cy.stat.csv |
Object with file name of *.csv file with calendar year percentile statistics. |
file.cy.stat.trans.csv |
Object with file name of *.csv file with transposed calendar year percentile statistics. |
Q.wy.percentile.stat |
Data frame with the water year percentiles of |
Q.wy.percentile.stat.trans |
Data frame with the water year percentiles of |
file.wy.stat.csv |
Object with file name of *.csv file with water year percentile statistics. |
file.wy.stat.trans.csv |
Object with file name of *.csv file with transposed water year percentile statistics. |
na.rm |
Missing value flags. |
Version |
Version of this function. |
Date |
Date function was run. |
1 2 3 4 5 6 7 8 | ## Not run:
percentile.longterm <- compute.Q.percentile.longterm(
Station.Code ='ABCDE',
flow =flow,
start.year =1960,
end.year =2015)
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.