diff --git a/README.md b/README.md index 422df8e4f00271095f33519d7de253bf4e6e7b3e..531998a0567081523ff9005a5fcf9f1df2fab6ce 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,25 @@ # Time-course analysis web-app -## Runnning instance +- [Time-course analysis web-app](#time-course-analysis-web-app) + * [Running the app](#running-the-app) + + [Runnning instance](#runnning-instance) + + [Running the app on the server](#running-the-app-on-the-server) + + [Running the app locally](#running-the-app-locally) + * [Input file](#input-file) + - [Long format](#long-format) + - [Wide format](#wide-format) + * [Unique track IDs](#unique-track-ids) + * [Modules](#modules) + + +## Running the app +### Running instance Access the running instance of the app on [shinyapps.io](https://macdobry.shinyapps.io/tcourse-inspector/ "TimeCourse Inspector") -## Running the app on the server +### Running the app on the server The app can be deployed on RStudio/Shiny server. Follow instruction [here](https://shiny.rstudio.com/deploy/ "Shiny - Hosting"). -## Running the app locally +### Running the app locally Alternatively, after downloading the code, the app can run within RStudio. Open `server.R` or `ui.R` file, then click "Run App" button with green triangle in the upper right corner of the window with code open. Following packages need to be installed in order to run the app locally: @@ -45,6 +58,13 @@ install.packages(c("shiny", "shinyjs", "shinyBS", "shinycssloaders", "imputeTS", "MASS", "robust", "pracma", "Hmisc")) ``` +### Running the app locally with a temporary copy +Running the 2 following lines should get you started immediatly with a temporary copy of the app: +``` +library(shiny) +runGitHub("dmattek/shiny-timecourse-inspector") +``` + ## Input file The app recognizes CSV (comma-separated values) files where data columns are separated by a comma and floating point numbers use a dot (full-stop). Compressed CSV files in zip or bz2 format can be uploaded directly without decompression. Both long and wide data formats are accepted but we highly recommend using the long format because it allows for multiple groupings and multivariate measurements.