R/write_full_analysis.R
write_full_analysis.Rd
Calculates and writes tables and plots from a suite of statistics from fasstr
functions into
an Excel workbook, and accompanying plot files for certain analyses. 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. Calculates statistics from all values, unless specified. Returns a list of tibbles and
plots, along with saving the Excel and image files in a directory.
write_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, ignore_missing = FALSE, zyp_method = "yuepilon", zyp_alpha, file_name, plot_filetype = "pdf" )
data  Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank if using 

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 to use the first year of the source data. 
end_year  Numeric value of the last year to consider for analysis. Leave blank to use the last year of the source data. 
exclude_years  Numeric vector of years to exclude from analysis. Leave blank to include all years. 
ignore_missing  Logical value indicating whether dates with missing values should be included in the calculation. If

zyp_method  Character string identifying the prewhitened trend method to use from 
zyp_alpha  Numeric value of the significance level (ex. 
file_name  Character string of the name of the Excel Workbook (and folder for plots if necessary) to create on drive to write all results. 
plot_filetype  Image type to write. One of 
compute_full_analysis
,
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_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_outside_normal
,
plot_annual_outside_normal
,
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
if (FALSE) { # Working examples: # Save a full analysis will all the analyses write_full_analysis(station_number = "08NM116", file_name = "Mission Creek", start_year = 1980, end_year = 2010) # Save a full analysis with only Annual and Daily analyses write_full_analysis(station_number = "08NM116", file_name = "Mission Creek", start_year = 1980, end_year = 2010, analyses = c(3,5)) }