View source: R/compute_full_analysis.R
compute_full_analysis  R Documentation 
Calculates tables and plots from a suite of statistics from fasstr
functions. Calculates statistics from all
values, unless specified.The statistics are grouped into 7 analysis groups (see analyses
argument) which are stored in
lists in the object. Due to the number of tables and plots to be made, this function may take several minutes to complete. If
ignore_missing = FALSE
(default) and there is missing data, some tables and plots may be empty and produce warnings.
Use ignore_missing = TRUE
to ignore the missing values or filter your data to complete years.
Returns a list of tibbles and plots.
compute_full_analysis(
data,
dates = Date,
values = Value,
groups = STATION_NUMBER,
station_number,
analyses = 1:7,
basin_area,
water_year_start = 1,
start_year,
end_year,
exclude_years,
months = 1:12,
complete_years = FALSE,
ignore_missing = FALSE,
allowed_missing_annual = ifelse(ignore_missing, 100, 0),
allowed_missing_monthly = ifelse(ignore_missing, 100, 0),
zyp_method = "zhang",
zyp_alpha
)
data 
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to 
dates 
Name of column in 
values 
Name of column in 
groups 
Name of column in 
station_number 
Character string vector of seven digit Water Survey of Canada station numbers (e.g. 
analyses 
Numeric vector of analyses to run (default is all (

basin_area 
Upstream drainage basin area, in square kilometres, to apply to observations. Three options: (1) Leave blank if (2) A single numeric value to apply to all observations. (3) List each basin area for each group/station in groups (can override HYDAT value if listed) as such 
water_year_start 
Numeric value indicating the month ( 
start_year 
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.

end_year 
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.

exclude_years 
Numeric vector of years to exclude from analysis. Leave blank or set to 
months 
Numeric vector of months to include in analysis. For example, 
complete_years 
Logical values indicating whether to include only years with complete data in analysis. Default 
ignore_missing 
Logical value indicating whether dates with missing values should be included in the calculation. If

allowed_missing_annual 
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate an annual statistic (0 to 100 percent). If 
allowed_missing_monthly 
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a monthly statistic (0 to 100 percent). If 
zyp_method 
Character string identifying the prewhitened trend method to use from 
zyp_alpha 
Numeric value of the significance level (ex. 
A list of lists of tibble data frames and ggplot2 objects from various fasstr functions organized by the analysis groups as listed above.
plot_flow_data
,
screen_flow_data
,
plot_data_screening
,
plot_missing_dates
,
calc_longterm_monthly_stats
,
plot_longterm_monthly_stats
,
calc_longterm_daily_stats
,
plot_longterm_daily_stats
,
plot_monthly_means
,
plot_flow_duration
,
calc_annual_stats
,
plot_annual_stats
,
calc_annual_cumulative_stats
,
plot_annual_cumulative_stats
,
calc_annual_flow_timing
,
plot_annual_flow_timing
,
calc_annual_normal_days
,
plot_annual_normal_days
,
calc_annual_lowflows
,
plot_annual_lowflows
,
plot_annual_means
,
calc_monthly_stats
,
plot_monthly_stats
,
calc_monthly_cumulative_stats
,
plot_monthly_cumulative_stats
,
calc_daily_stats
,
plot_daily_stats
,
calc_daily_cumulative_stats
,
plot_daily_cumulative_stats
,
compute_annual_trends
,
compute_annual_frequencies
,
write_flow_data
,
write_plots
## Not run:
# Working examples:
# Compute a full analysis will all the analyses
results < compute_full_analysis(station_number = "08NM116",
start_year = 1980,
end_year = 2010)
# Compute a full analysis with only Annual (3) and Daily (5) analyses
results < compute_full_analysis(station_number = "08NM116",
start_year = 1980,
end_year = 2010,
analyses = c(3,5))
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.