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
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:
- Introduction
- An overview of the basic fucntionality of the package
- LakeCat
- An overview of accessing data for lakes within the package and functions to do so
- Applications
- A more in depth walk through with specific use-case examples and demonstrations
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 (????). _StreamCatTools: 'StreamCatTools'_. R package version
#> 0.9.1, https://github.com/USEPA/StreamCatTools,
#> <https://usepa.github.io/StreamCatTools/>.
#>
#> A BibTeX entry for LaTeX users is
#>
#> @Manual{,
#> title = {StreamCatTools: 'StreamCatTools'},
#> author = {Marc Weber},
#> note = {R package version 0.9.1, https://github.com/USEPA/StreamCatTools},
#> url = {https://usepa.github.io/StreamCatTools/},
#> }