Due to a scheduled upgrade to version 14.10, GitLab will be unavailabe on Monday 30.05., from 19:00 until 20:00.

README.md 2.42 KB
Newer Older
dmattek's avatar
dmattek committed
1
2
# Time-course analysis web-app

dmattek's avatar
dmattek committed
3
## Running the app from the server
dmattek's avatar
dmattek committed
4
The app can be accessed here:
Maciej Dobrzynski's avatar
Maciej Dobrzynski committed
5
http://pertzlab.unibe.ch:3838/shiny-timecourse-inspector/ (UniBe VPN only!)
dmattek's avatar
dmattek committed
6

dmattek's avatar
dmattek committed
7
## Running the app locally
dmattek's avatar
dmattek committed
8
9
10
11
12
13
14
15
16
Alternatively, after downloading the code, the app can be 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:

* shiny
* shinyjs
* data.table
* ggplot2
* gplots
dmattek's avatar
dmattek committed
17
* scales
dmattek's avatar
dmattek committed
18
19
20
21
22
* plotly
* d3heatmap
* dendextend
* RColorBrewer
* sparcl
dmattek's avatar
dmattek committed
23
24
* imputeTS
* dtw
25
26
27
28
* DT
* MASS
* robust
* pracma
29
* Hmisc
dmattek's avatar
dmattek committed
30
31
32

Install packages using `install.packages('name_of_the_package_from_the_list_above')` command in RStudio command line.

dmattek's avatar
dmattek committed
33
34
```
install.packages(c("shiny", "shinyjs", 
35
					"data.table", "DT",
dmattek's avatar
dmattek committed
36
37
38
					"ggplot2", "gplots", "plotly", "d3heatmap", "scales",
					"dendextend", "dendextend", "RColorBrewer",
					"sparcl", "dtw",
39
					"imputeTS",
40
					"MASS", "robust", "pracma", "Hmisc")) 
41
42
```

dmattek's avatar
dmattek committed
43
44
## Input file
The app recognises CSV (comma-separated values) files: data columns separated by a comma, floating point numbers using a dot (full-stop).
dmattek's avatar
dmattek committed
45
46
47
48

The data file has to be in a so called long format, where individual time-courses (tracks) are arranged one after another. Note a wide-format where individual tracks are arranged in neighbouring columns is NOT supported!

Sample few lines of the input file:
dmattek's avatar
dmattek committed
49
50
51
52
53
54
```
"Metadata_Series", "TrackObjects_Label", "Intensity_MeanIntensity_Ratio", "RealTime", "Stim_All_Ch", "Stim_All_S"
0, 2, 1149.00311105531, 0, "Ch01: FGF 250 ng/ml 60min pulse", "S00: FGF 250 ng/ml 60min pulse"
0, 3, 1160.43905280656, 0, "Ch01: FGF 250 ng/ml 60min pulse", "S00: FGF 250 ng/ml 60min pulse"
0, 4, 1303.06046656558, 0, "Ch01: FGF 250 ng/ml 60min pulse", "S00: FGF 250 ng/ml 60min pulse"
```
dmattek's avatar
dmattek committed
55
56
57
58
59
60
61
62
63

The first row should include column headers. Necessary columns include:

* Unique number of the field of view (FOV), here "Metadata_Series"
* Unique identifier of track ID within the FOV, here "TrackObjects_Label"
* Time point, here "RealTime"
* Measurement column (can be many columns), here "Intensity_MeanIntensity_Ratio"

Additionally, columns with condition names can be included. In the example above, "Stim_All_S" identifies condition per FOV, and "Stim_All_Ch" relates to a condition name within the well. These two columns are useful to group and plot time-courses in separate facets per FOV or per well.