From 94b7fcb0e651b856009978c5304cef5ff8ab9ee6 Mon Sep 17 00:00:00 2001
From: Craig Williams <craig@avsdev.uk>
Date: Thu, 11 Apr 2019 11:10:34 +0100
Subject: [PATCH] Added a basic readme with installation instructions

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4ceee6f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+## Installation
+
+#### Required R libraries:
+- bnlearn
+- DT
+- ggplot2
+- graph
+- htmltools
+- kableExtra
+- knitr
+- magrittr
+- openxlsx
+- plotly
+- processx
+- RColorBrewer
+- shiny
+- shinyBS
+- shinycssloaders
+- shinydashboard
+- shinydashboardPlus
+- shinyjs
+- stringr
+- vizNetwork
+- zip
+```
+install.packages(c("bnlearn", "DT", "ggplot2", "graph", "htmltools", "kableExtra", "knitr", "magrittr", "openxlsx", "plotly", "processx", "RColorBrewer", "shiny", "shinyBS", "shinycssloaders", "shinydashboard", "shinydashboardPlus", "shinyjs", "stringr", "vizNetwork", "zip", "devtools"))
+devtools::install_github("ropensci/plotly")
+```
+
+#### ORCA for downloads:
+- NodeJs (v8)
+- electron
+- orca
+```
+npm install 
+export PATH=`pwd`/node_modules/.bin:$PATH
+```
+NOTE: remember to export the path when running the application so that R can find orca
+
+#### Start script (optional)
+Assumes application runs under the `shiny` account
+```
+#!/bin/bash
+
+if [ "$(whoami)" != "shiny" ]; then
+    sudo -u shiny $0
+    exit 1
+fi
+
+export NVM_DIR="$HOME/.nvm"
+[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"  # This loads nvm
+
+export PATH=/srv/shiny/bin:$PATH
+
+screen -dmS MESO R --vanilla -e "shiny::runApp('app.R', host = '0.0.0.0', port = 6376)"
+```
\ No newline at end of file