rict

Overview

An R package for calculating River Invertebrate Classification Tool (RICT) predictions.

Work in progress

This R package is in development. Please don’t use in production. Please use the RICT website for official documentation and links to the Azure experiments.

Install

Install R and we also recommend installing Rstudio.

Alternatively, use R Cloud through your browser.

In the R console, install the development version from GitHub:

install.packages("devtools")
library(devtools)
install_github("aquaMetrics/rict")
library(rict)

Open interactive web app:

rict_app()

Or run the demo dataset through the rict function in R to get classification results:

results <- rict(demo_observed_values)

Use rict_predict to only calculate predictions:

predictions <- rict_predict(demo_observed_values)

And rict_classify to classify these predictions:

results <- rict_classify(predictions)

See documentation for further usage details. For example, how to change the default year_type from multi-year to single year classification:

results <- rict(demo_gis_values_log, year_type = "single")

Contributing

Please read the Contributing Guidelines file for more details.

Code of Conduct

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.