README-LakeMonitoR 

#> Last Update: 2021-07-13 09:18:50

LakeMonitoR

Suite of functions and tools for lake monitoring.

Badges

Maintenance lifecycle

License: GPL-3

CodeFactor codecov R-CMD-check

GitHub issues

GitHub release Github all releases

Installation

To install the current version of the code from GitHub use the example below.

if(!require(remotes)){install.packages("remotes")}  #install if needed
remotes::install_github("leppott/LakeMonitoR")

The vignette (big help file) isn’t created when installing from GitHub with the above command. If you want the vignette download the compressed file from GitHub and install from that file or install with the command below. The “force = TRUE” command is used to ensure the package will install over and existing install of the same version (e.g., the same version without the vignettes).

if(!require(remotes)){install.packages("remotes")}  #install if needed
remotes::install_github("leppott/LakeMonitoR", force = TRUE, build_vignettes = TRUE)

Purpose

Aid analysis of temperature and dissolved oxygen depth profiles from lakes.

Issues

https://github.com/leppott/LakeMonitoR/issues

Documentation

Included Vignette and install guide.

Shiny App

A Shiny app is included in the package.

The online version is hosted at https://tetratech-wtr-wne.shinyapps.io/LakeMonitoR

The Shiny app can be run from R console using the shiny package without installing the LakeMonitoR package.

if(!require(shiny)){install.packages("shiny")}
shiny::runGitHub(repo = "LakeMonitoR"
                , username = "leppott"
                , ref = "main"
                , subdir = "inst/shiny-examples/LakeMonitoR")