StartHere

Installing and loading StreamCatTools

To install, you can install from CRAN:

install.packages("StreamCatTools")

Or you can install from GitHub:

library(devtools)
install_github('USEPA/StreamCatTools')

After installing load the library

library(StreamCatTools)

Background

The StreamCatTools package was designed to simplify the use of StreamCat data in R, leveraging the new API for StreamCat.

Vignettes in StreamCatTools

There are three additional vignettes in StreamCatTools that are available on our website here under the “Articles” tab:

  1. Introduction
  1. LakeCat
  1. Applications

These vignettes cover some of the core functions (and arguments within those functions) in StreamCatTools. Help files for a particular function are viewable by running ?function_name after loading StreamCatTools. For example, to learn more about the sc_get_data() function, run ?sc-get_data.

Citation information

If you use StreamCatTools in your work, please cite it. You can view the most recent citation by running

citation("StreamCatTools")
#> To cite package 'StreamCatTools' in publications use:
#> 
#>   Weber M, Hill R, Markley S, Hudson T, Brookes A (2026).
#>   _StreamCatTools: Tools for Working with 'StreamCat' and 'LakeCat'
#>   Data_. R package version 0.12.0,
#>   <https://usepa.github.io/StreamCatTools/>.
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Manual{,
#>     title = {StreamCatTools: Tools for Working with 'StreamCat' and 'LakeCat' Data},
#>     author = {Marc Weber and Ryan Hill and Selia Markley and Travis Hudson and Allen Brookes},
#>     year = {2026},
#>     note = {R package version 0.12.0},
#>     url = {https://usepa.github.io/StreamCatTools/},
#>   }