Skip to content

Latest commit

 

History

History
139 lines (106 loc) · 5.75 KB

index.md

File metadata and controls

139 lines (106 loc) · 5.75 KB
Raw

fasstr

img License R-CMD-check

CRAN_Status_Badge CRAN Downloads cran checks

The Flow Analysis Summary Statistics Tool for R (fasstr) is a set of R functions to tidy, summarize, analyze, trend, and visualize streamflow data. This package summarizes continuous daily mean streamflow data into various daily, monthly, annual, and long-term statistics, completes annual trends and frequency analyses.

This package provides functions for streamflow data analysis, including:

  • data tidying (to prepare data for analyses; add_* and fill_* functions),
  • data screening (to identify data range, outliers and missing data; screen_* functions),
  • calculating summary statistics (long-term, annual, monthly and daily statistics; calc_*functions),
  • computing analyses (volume frequency analyses and annual trending; compute_* functions), and,
  • visualizing data (plotting the various statistics; plot_* functions).

Useful features of functions include:

  • the integration of the tidyhydat package to pull streamflow data from a Water Survey of Canada HYDAT database for analyses;
  • arguments for filtering of years and months in analyses and plotting;
  • choosing the start month of your water year;
  • selecting for rolling day averages (e.g. 7-day rolling average); and,
  • choosing how missing dates are handled, amongst others.

This package is maintained by the Water Management Branch of the British Columbia Ministry of Water, Land and Resource Stewardship.

Installation

You can install fasstr directly from CRAN:

install.packages("fasstr")

To install the development version from GitHub, use the remotes package then the fasstr package:

if(!requireNamespace("remotes")) install.packages("remotes")
remotes::install_github("bcgov/fasstr")

To use the station_number argument and pull data directly from a Water Survey of Canada HYDAT database into fasstr functions, download a HYDAT file using the following code:

tidyhydat::download_hydat()

Using fasstr

There are several vignettes and a cheatsheet to provide more information on the usage of fasstr functions and how to customize various argument options.

Cheatsheet

Getting Help or Reporting an Issue

To report bugs/issues/feature requests, please file an issue.

How to Contribute

If you would like to contribute to the package, please see our CONTRIBUTING guidelines.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

Copyright 2019 Province of British Columbia

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at 

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.