Installation - chronopsychiatry/AmbientViewer GitHub Wiki

Ambient Viewer can be used in three different ways:

  • Online
  • Running as a shiny app locally
  • As an R package, to use functions in your own scripts

Online

In your web-browser, open Ambient Viewer.

The app is kept up-to-date with the latest github version.

As a local Shiny app

This allows to run the app on your local machine. Once installed, you will not need a network connection to run it.

Updates must be done manually by repeating this installation process.

  1. Install the AmbientViewer package
devtools::install_github("Chronopsychiatry/AmbientViewer", force = TRUE)
  1. Load the library
library(AmbientViewer)
  1. Start the application (will open in a web browser window)
ambient_viewer()
  1. Alternatively, AmbientViewer functions can be used in R scripts after the library has been loaded (see the Example script).

R package

Follow the steps to install the package as listed above. Once you have loaded the library, you will have access to Ambient Viewer R functions. A list of available functions is available in the package manual (choose the manual that corresponds to your version).

If you are not sure which version of Ambient Viewer you have installed, run (in R) packageVersion("AmbientViewer").

To update the package, run:

devtools::install_github("Chronopsychiatry/AmbientViewer", force = TRUE)