R package

TIDAL can be used by installing the TIDAL R package and launching the R Shiny application locally (rather than using and uploading data to the tool online).

Installation

1. Install the statistical programing language R
2. We also reccomend installing R Studio

3. Install the TIDAL R package and launch the application by running the code below in your R console. Please see video and text below for demo and function documentation.

   If using R Studio it’s recommended to restart your R session before installing.

    install.packages("remotes")
    remotes::install_github("TIDAL-modelling/TIDAL")
    # Note if prompted to update packages you can select option 3/None.
    # Updating all packages (option 1) might take a while to run.
    library("TIDAL")
    # Launch the R Shiny app
    launchTIDAL()
    # To get documentation for launchTIDAL()
    ?launchTIDAL
   

Documentation for the function “launchTIDAL”

Run Shiny app from local R environment

Description

Opens an interactive Shiny GUI.

Usage

launchTIDAL(display = "default")

Arguments

• display:
  Character vector. Can be either "default" or "browser". Default is "default".
  • "default": Opens the Shiny app in a pop-out window in RStudio.
  • "browser": Opens the app in a web browser.

Examples

Run examples

## Not run: 
# Launch Shiny app with default display
launchTIDAL()

# Launch Shiny app with browser display
launchTIDAL(display = "browser")
## End(Not run)

Notes

You can also manually open a browser and copy and paste the URL after “Listening on” into the address bar. For example, if it says:

Listening on http://127.0.0.1:4484

Copy and paste http://127.0.0.1:4484 into your browser, such as Chrome or Firefox.

Even though you are using a browser, the app is still running locally on your computer, the same as if the pop-out window was launched from RStudio.