Package: fasstr 0.5.3

Jon Goetz

fasstr: Analyze, Summarize, and Visualize Daily Streamflow Data

The Flow Analysis Summary Statistics Tool for R, 'fasstr', provides various functions to tidy and screen daily stream discharge data, calculate and visualize various summary statistics and metrics, and compute annual trending and volume frequency analyses. It features useful function arguments for filtering of and handling dates, customizing data and metrics, and the ability to pull daily data directly from the Water Survey of Canada hydrometric database (<https://collaboration.cmc.ec.gc.ca/cmc/hydrometrics/www/>).

Authors:Jon Goetz [aut, cre], Carl James Schwarz [aut], Sam Albers [ctb], Robin Pike [ctb], Province of British Columbia [cph]

fasstr_0.5.3.tar.gz
fasstr_0.5.3.zip(r-4.7)fasstr_0.5.3.zip(r-4.6)fasstr_0.5.3.zip(r-4.5)
fasstr_0.5.3.tgz(r-4.6-any)fasstr_0.5.3.tgz(r-4.5-any)
fasstr_0.5.3.tar.gz(r-4.7-any)fasstr_0.5.3.tar.gz(r-4.6-any)
fasstr_0.5.3.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
fasstr/json (API)

# Install 'fasstr' in R:
install.packages('fasstr', repos = c('https://bcgov.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/bcgov/fasstr/issues

Pkgdown/docs site:https://bcgov.github.io

On CRAN:

Conda:

bcgovforfrequency-analysishydathydrologystreamflowsummary-statisticstrendswater

7.27 score 59 stars 104 scripts 471 downloads 68 exports 72 dependencies

Last updated from:de8a605493. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK162
source / vignettesOK285
linux-release-x86_64OK158
macos-release-arm64OK100
macos-oldrel-arm64OK102
windows-develOK128
windows-releaseOK106
windows-oldrelOK101
wasm-releaseOK159

Exports:%>%add_basin_areaadd_cumulative_volumeadd_cumulative_yieldadd_daily_volumeadd_daily_yieldadd_date_variablesadd_rolling_meansadd_seasonscalc_all_annual_statscalc_annual_cumulative_statscalc_annual_extremescalc_annual_flow_timingcalc_annual_highflowscalc_annual_lowflowscalc_annual_normal_dayscalc_annual_outside_normalcalc_annual_peakscalc_annual_statscalc_daily_cumulative_statscalc_daily_statscalc_flow_percentilecalc_longterm_daily_statscalc_longterm_meancalc_longterm_monthly_statscalc_longterm_percentilecalc_monthly_cumulative_statscalc_monthly_statscompute_annual_frequenciescompute_annual_trendscompute_frequency_analysiscompute_frequency_quantilecompute_full_analysiscompute_hydat_peak_frequenciesfill_missing_datesplot_annual_cumulative_statsplot_annual_extremesplot_annual_extremes_yearplot_annual_flow_timingplot_annual_flow_timing_yearplot_annual_highflowsplot_annual_lowflowsplot_annual_meansplot_annual_normal_daysplot_annual_normal_days_yearplot_annual_outside_normalplot_annual_statsplot_annual_stats2plot_annual_symbolsplot_daily_cumulative_statsplot_daily_statsplot_data_screeningplot_flow_dataplot_flow_data_symbolsplot_flow_durationplot_longterm_daily_statsplot_longterm_monthly_statsplot_missing_datesplot_monthly_cumulative_statsplot_monthly_meansplot_monthly_statsplot_monthly_stats2screen_flow_datawrite_flow_datawrite_full_analysiswrite_objects_listwrite_plotswrite_results

Dependencies:askpassbitbit64blobbootcachemclassclicliprcpp11crayoncurlDBIdbplyrdplyre1071farverfastmapfitdistrplusgenericsggplot2gluegtablehmshttr2isobandKendalllabelinglatticelifecyclelubridatemagrittrMASSMatrixmemoiseopensslopenxlsxPearsonDSpillarpkgconfigplyrprettyunitsprogressproxypurrrR6rappdirsRColorBrewerRcppRcppRollreadrrlangRSQLiteS7scalesstringistringrsurvivalsystibbletidyhydattidyrtidyselecttimechangetzdbutf8vctrsviridisLitevroomwithrzipzyp

Computing a Full Analysis with fasstr
Overview | Functions and Data Inputs | compute_full_analysis() Object List | write_full_analysis() Excel and Image Files | Usage, Options, and outputs | Objects Examples | 1. Screening | 2. Long-term | 3. Annual | 4. Monthly | 5. Daily | 6. Trending | 7. Low-flow Frequencies
Rendered fromfasstr_full_analysis.Rmdusingknitr::rmarkdown

Last update: 2022-10-19
Started: 2018-06-28

Get Started with fasstr
Features | Installation | Using fasstr | Data Input | Function Types | Tidying | Analysis | Visualization | Function Options | Daily Rolling Means | Year and Month Filtering | Drainage Basin Area | Handling Missing Dates | Examples | Summary statistics example: long-term statistics | Plotting example: daily summary statistics | Plotting example: flow duration curves | Analysis example: low-flow frequency analysis
Rendered fromfasstr.Rmdusingknitr::rmarkdown

Last update: 2022-05-30
Started: 2020-05-22

fasstr Users Guide
1. Getting Started | Installing and loading fasstr | Downloading HYDAT | 2. Flow Data Inputs | data (and dates, values, and groups) | station_number | 3. Function Types and Outputs | Tibble Data Frames | ggplot2 Plots | 4. Data Tidying Functions | Filling missing dates | Adding date variables and seasons | Adding rolling means | Adding basin areas | Adding daily volumetric discharge or water yields | Adding annual cumulative daily volumetric flows or water yields | Pipelines | 5. Data Screening Functions | 6. Functions for Calculating Statistics | Basic Summary Statistics | Basic long-term statistics | Basic annual statistics | Basic monthly statistics | Basic daily statistics | Flow Duration | Other Long-term Statistics | Basic statistics and plotting volumetric and yield flows | Cumulative Flow Statistics | Cumulative annual statistics | Cumulative monthly and statistics | Cumulative daily statistics | Other Annual Statistics | Annual flow timing | Annual low-flows | Annual high flows | Annual extreme (both high and low) flows | Number of normal (and above/below normal) days per year | Calculating all annual statistics | Plotting annual means | 7. Functions for Computing Analyses | Annual Trending Analysis | Volume Frequency Analyses | Full Analysis | 8. Customizing Functions with Arguments - Data Filtering and Options | Handling Missing Dates | Dates Filtering | Water year and start month | Selecting and excluding years | Using only years with complete data | Selecting for months | Rolling averages | Percentiles and other statistics | Data frame options | Plotting options | Logarithmic discharge scale | Including a standard title on the plot | 9. Writing Tables and Plots | Writing a flow data set | Writing a data frame | Writing a list of plots | Writing a list of data frames and plots
Rendered fromfasstr_users_guide.Rmdusingknitr::rmarkdown

Last update: 2022-05-25
Started: 2018-06-18

Computing Annual Trends with fasstr
Overview | Function and Data Inputs | Usage, Options, and Outputs | Analysis Data | Examples | Analysis Results | Annual Trends Plots
Rendered fromfasstr_trending_analysis.Rmdusingknitr::rmarkdown

Last update: 2022-05-03
Started: 2018-06-18

Computing Frequency Analyses with fasstr
Overview | Functions and Data Inputs | Annual Daily Minimums/Maximums | Annual Peak Minimums/Maximums from HYDAT | Custom Data | Usage, Options, and Outputs | Analysis Data | Frequency Plotting | Distribution Fitting and Computing Frequency Quantiles | Fitting Data to Probability Distributions | Fitted Quantiles | Notes on use of the Log-Pearson Type III Distribution
Rendered fromfasstr_frequency_analysis.Rmdusingknitr::rmarkdown

Last update: 2022-05-03
Started: 2018-06-18

Internal fasstr Workflows
Introduction | 1. Data Importing and Checking | 2. Tidying Functions (add_ and fill_) | 3. Analysis Functions (calc_ and compute_) | Data Tidying and Preparing | Data Filtering | Calculating Statistics | Final Data Wrangling | 4. Plotting Functions (plot_) | Plotting Statistics | 5. Internal Functions (utils.R file) | 6. Package Dependencies
Rendered fromfasstr_under_the_hood.Rmdusingknitr::rmarkdown

Last update: 2021-12-03
Started: 2018-06-18

Readme and manuals

Help Manual

Help pageTopics
Add a basin area column to daily flowsadd_basin_area
Add a daily cumulative volumetric flows column to daily flowsadd_cumulative_volume
Add a daily cumulative water yield column to daily flowsadd_cumulative_yield
Add a daily volumetric flows column to daily flowsadd_daily_volume
Add a daily volumetric water yield column to daily flowsadd_daily_yield
Add year, month, and day of year variable columns to daily flowsadd_date_variables
Add rolling n-day average column(s) to daily flowsadd_rolling_means
Add a column of seasonsadd_seasons
Calculate all fasstr annual statisticscalc_all_annual_stats
Calculate annual (and seasonal) total cumulative flowscalc_annual_cumulative_stats
Calculate annual high and low flowscalc_annual_extremes
Calculate annual timing of flowscalc_annual_flow_timing
Calculate annual high flows and datescalc_annual_highflows
Calculate annual low flows and datescalc_annual_lowflows
Calculate annual days above and below normalcalc_annual_normal_days
Calculate annual days above and below normalcalc_annual_outside_normal
Calculate annual high and low flowscalc_annual_peaks
Calculate annual summary statisticscalc_annual_stats
Calculate cumulative daily flow statisticscalc_daily_cumulative_stats
Calculate daily summary statisticscalc_daily_stats
Calculate the percentile rank of a flow valuecalc_flow_percentile
Calculate long-term summary statistics from daily mean flowscalc_longterm_daily_stats
Calculate the long-term mean annual dischargecalc_longterm_mean
Calculate long-term summary statistics from annual monthly mean flowscalc_longterm_monthly_stats
Calculate long-term percentilescalc_longterm_percentile
Calculate cumulative monthly flow statisticscalc_monthly_cumulative_stats
Calculate monthly summary statisticscalc_monthly_stats
Perform an annual low or high-flow frequency analysiscompute_annual_frequencies
Calculate prewhitened nonlinear annual trends on streamflow datacompute_annual_trends
Perform a custom volume frequency analysiscompute_frequency_analysis
Calculate an annual frequency analysis quantilecompute_frequency_quantile
Compute a suite of tables and plots from various fasstr functionscompute_full_analysis
Perform a frequency analysis on annual peak statistics from HYDATcompute_hydat_peak_frequencies
Fills data gaps of missing datesfill_missing_dates
Plot annual (and seasonal) total cumulative flowsplot_annual_cumulative_stats
Plot annual high and low flowsplot_annual_extremes
Plot annual high and low flows for a specific yearplot_annual_extremes_year
Plot annual timing of flowsplot_annual_flow_timing
Plot annual timing of flows for a specific yearplot_annual_flow_timing_year
Plot annual high flows and datesplot_annual_highflows
Plot annual low flows and datesplot_annual_lowflows
Plot annual means compared to the long-term meanplot_annual_means
Plot annual count of normal days and days above and below normalplot_annual_normal_days
Plot days above normal, below normal and normal for a specific yearplot_annual_normal_days_year
Plot annual days above and below normalplot_annual_outside_normal
Plot annual summary statistics (as lines)plot_annual_stats
Plot annual summary statistics (as ribbons)plot_annual_stats2
Plot daily streamflow data symbols by yearplot_annual_symbols
Plot cumulative daily flow statisticsplot_daily_cumulative_stats
Plot daily summary statisticsplot_daily_stats
Plot annual summary statistics for data screeningplot_data_screening
Plot a daily streamflow data setplot_flow_data
Plot daily streamflow data with their symbolsplot_flow_data_symbols
Plot flow duration curvesplot_flow_duration
Plot long-term summary statistics from daily mean flowsplot_longterm_daily_stats
Plot long-term summary statistics from annual monthly mean flowsplot_longterm_monthly_stats
Plot annual and monthly missing datesplot_missing_dates
Plot cumulative monthly flow statisticsplot_monthly_cumulative_stats
Plot monthly means and percent LTMADsplot_monthly_means
Plot monthly summary statisticsplot_monthly_stats
Plot monthly summary statistics (as ribbons)plot_monthly_stats2
Calculate annual summary and missing data statistics for screening datascreen_flow_data
Write a streamflow dataset as a .xlsx, .xls, or .csv filewrite_flow_data
Write a suite of tables and plots from various fasstr functions into a directorywrite_full_analysis
Write all data frames and plots from a list of objects into a directorywrite_objects_list
Write plots from a list into a directory or PDF documentwrite_plots
Write a data frame as a .xlsx, .xls, or .csv filewrite_results