Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 1.3 KB

README.md

File metadata and controls

47 lines (34 loc) · 1.3 KB
Raw

{tfpbrowser}

An R package to build a Shiny application to explore {tfpscanner} outputs. The outputs from {tfpscanner} should be stored in the inst/app/www/data/ folder.

Installation

remotes::install_github("mrc-ide/tfpbrowser")

Running the Shiny application

tfpbrowser::run_app()

Updating with new data

  • See the notes on using tfpscanner::create_browser_data() with tfpbrowser in the README for {tfpscanner}
  • Either:
    • configure {tfpbrowser} to use the output data directory used in create_browser_data() (see the next section); or
    • copy the contents of that directory into inst/app/www/data/ and re-install {tfpbrowser}

Configuring the deployed app

Data presented by the app can be obtained from an arbitrary directory on the server. To configure the data-directory, use the environment variable APP_DATA_DIR. For example, if the app is to present data from the directory /home/me/tfpdata/, then the app can be configured from the command line:

APP_DATA_DIR=/home/me/tfpdata/
# start the app

... or from inside R:

Sys.setenv("APP_DATA_DIR" = "/home/me/tfpdata/")
pkgload::load_all()
run_app()

An alternative way to specify this data directory is to add the line APP_DATA_DIR="/home/me/tfpdata/" to a .Renviron file in the project root.