trajPlot.R 8.92 KB
Newer Older
dmattek's avatar
dmattek committed
1
2
3
4
#
# Time Course Inspector: Shiny app for plotting time series data
# Author: Maciej Dobrzynski
#
dmattek's avatar
dmattek committed
5
# This module is for plotting individual time series
dmattek's avatar
dmattek committed
6
7
8
9
10
#


# UI ----

dmattek's avatar
Mod:  
dmattek committed
11
12
13
14
15
16
modTrajPlotUI =  function(id, label = "Plot Individual Time Series") {
  ns <- NS(id)
  
  tagList(
    fluidRow(
      column(
Maciej Dobrzynski's avatar
Maciej Dobrzynski committed
17
        2,
dmattek's avatar
Mod:  
dmattek committed
18
19
20
        numericInput(
          ns('inPlotTrajFacetNcol'),
          '#Columns:',
21
          value = PLOTNFACETDEFAULT,
dmattek's avatar
Mod:  
dmattek committed
22
23
24
25
          min = 1,
          width = '100px',
          step = 1
        ),
26
        checkboxInput(ns('chBplotTrajInt'), 'Interactive Plot'),
dmattek's avatar
Mod:  
dmattek committed
27
28
29
        actionButton(ns('butPlotTraj'), 'Plot!')
      ),
      column(
Maciej Dobrzynski's avatar
Maciej Dobrzynski committed
30
        2,
dmattek's avatar
dmattek committed
31
32
33
        checkboxGroupInput(ns('chBPlotTrajStat'), 'Stats:', list('Mean' = 'mean', 
                                                                 '95% conf. interv.' = 'CI', 
                                                                 'Std. error' = 'SE'))
dmattek's avatar
Mod:  
dmattek committed
34
35
36
      ),
      column(
        3,
dmattek's avatar
dmattek committed
37
38
        sliderInput(ns('sliPlotTrajSkip'), 'Plot every n-th point:', 
                    min = 1, max = 10, value = 1, step = 1),
39
        
dmattek's avatar
dmattek committed
40
        checkboxInput(ns('chBsetXbounds'), 'Set bounds for x-axis', FALSE),
41
42
        fluidRow(
          column(6,
dmattek's avatar
dmattek committed
43
                 uiOutput(ns('uiSetXboundsLow'))
44
45
          ),
          column(6,
dmattek's avatar
dmattek committed
46
47
48
49
50
51
52
53
54
55
56
57
                 uiOutput(ns('uiSetXboundsHigh'))
          )),
        
        checkboxInput(ns('chBsetYbounds'), 'Set bounds for y-axis', FALSE),
        fluidRow(
          column(6,
                 uiOutput(ns('uiSetYboundsLow'))
          ),
          column(6,
                 uiOutput(ns('uiSetYboundsHigh'))
          ))
        
58
        
dmattek's avatar
Mod:  
dmattek committed
59
60
      ),
      column(
Maciej Dobrzynski's avatar
Maciej Dobrzynski committed
61
        2,
dmattek's avatar
Mod:  
dmattek committed
62
63
64
        numericInput(
          ns('inPlotTrajWidth'),
          'Width [%]:',
Maciej Dobrzynski's avatar
Maciej Dobrzynski committed
65
          value = PLOTWIDTH,
dmattek's avatar
Mod:  
dmattek committed
66
67
68
69
70
71
72
          min = 10,
          width = '100px',
          step = 10
        ),
        numericInput(
          ns('inPlotTrajHeight'),
          'Height [px]:',
Maciej Dobrzynski's avatar
Maciej Dobrzynski committed
73
          value = PLOTTRAJHEIGHT,
dmattek's avatar
Mod:  
dmattek committed
74
75
76
77
78
79
80
          min = 100,
          width = '100px',
          step = 50
        )
      )
    ),
    uiOutput(ns('uiPlotTraj')),
dmattek's avatar
dmattek committed
81
82
83
    br(),
    modTrackStatsUI(ns('dispTrackStats')),
    
dmattek's avatar
Mod:  
dmattek committed
84
85
86
87
    downPlotUI(ns('downPlotTraj'), "Download PDF")
  )
}

dmattek's avatar
dmattek committed
88
# Server ----
89
90
modTrajPlot = function(input, output, session, 
                       in.data, 
91
                       in.data.stim,
92
                       in.fname,
dmattek's avatar
dmattek committed
93
                       in.facet = COLGR, 
94
                       in.facet.color = NULL) {
dmattek's avatar
Mod:  
dmattek committed
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
  
  ns <- session$ns
  
  output$uiPlotTraj = renderUI({
    if (input$chBplotTrajInt)
      plotlyOutput(
        ns("outPlotTrajInt"),
        width = paste0(input$inPlotTrajWidth, '%'),
        height = paste0(input$inPlotTrajHeight, 'px')
      ) else
        plotOutput(
          ns("outPlotTraj"),
          width = paste0(input$inPlotTrajWidth, '%'),
          height = paste0(input$inPlotTrajHeight, 'px')
        )
  })
  
dmattek's avatar
dmattek committed
112
113
  # UI for bounding the x-axis ====
  output$uiSetXboundsLow = renderUI({
114
115
    ns <- session$ns
    
dmattek's avatar
dmattek committed
116
    if(input$chBsetXbounds) {
117
118
119
      
      loc.dt = in.data()
      
dmattek's avatar
dmattek committed
120
121
122
123
124
      if (is.null(loc.dt)) {
        cat(file = stderr(), 'uiSetXboundsLow: dt is NULL\n')
        return(NULL)
      }
      
125
      numericInput(
dmattek's avatar
dmattek committed
126
        ns('inSetXboundsLow'),
127
128
        label = 'Lower',
        step = 0.1, 
dmattek's avatar
dmattek committed
129
        value = floor(min(loc.dt[[COLRT]], na.rm = T))
130
131
132
133
134
      )
    }
  })
  
  
dmattek's avatar
dmattek committed
135
  output$uiSetXboundsHigh = renderUI({
136
137
    ns <- session$ns
    
dmattek's avatar
dmattek committed
138
    if(input$chBsetXbounds) {
139
140
141
      
      loc.dt = in.data()
      
dmattek's avatar
dmattek committed
142
143
144
145
146
      if (is.null(loc.dt)) {
        cat(file = stderr(), 'uiSetXboundsHigh: dt is NULL\n')
        return(NULL)
      }
      
147
      numericInput(
dmattek's avatar
dmattek committed
148
        ns('inSetXboundsHigh'),
149
150
        label = 'Upper',
        step = 0.1, 
dmattek's avatar
dmattek committed
151
        value = ceil(max(loc.dt[[COLRT]], na.rm = T))
152
153
154
      )
    }
  })
dmattek's avatar
dmattek committed
155
156
157
158
159
  
  
  # UI for bounding the y-axis ====
  output$uiSetYboundsLow = renderUI({
    ns <- session$ns
160
    
dmattek's avatar
dmattek committed
161
162
163
    if(input$chBsetYbounds) {
      
      loc.dt = in.data()
164
      
dmattek's avatar
dmattek committed
165
166
167
168
169
      if (is.null(loc.dt)) {
        cat(file = stderr(), 'uiSetYboundsLow: dt is NULL\n')
        return(NULL)
      }
      
dmattek's avatar
dmattek committed
170
171
172
173
174
175
176
      numericInput(
        ns('inSetYboundsLow'),
        label = 'Lower',
        step = 0.1, 
        value = floor(min(loc.dt[[COLY]], na.rm = T))
      )
    }
177
178
179
  })
  
  
dmattek's avatar
dmattek committed
180
181
182
183
184
185
186
  output$uiSetYboundsHigh = renderUI({
    ns <- session$ns
    
    if(input$chBsetYbounds) {
      
      loc.dt = in.data()
      
dmattek's avatar
dmattek committed
187
188
189
190
191
      if (is.null(loc.dt)) {
        cat(file = stderr(), 'uiSetYboundsHigh: dt is NULL\n')
        return(NULL)
      }
      
dmattek's avatar
dmattek committed
192
193
194
195
196
197
198
199
200
201
      numericInput(
        ns('inSetYboundsHigh'),
        label = 'Upper',
        step = 0.1, 
        value = ceil(max(loc.dt[[COLY]], na.rm = T))
      )
    }
  })
  
  # Plotting ====
202
  
dmattek's avatar
dmattek committed
203
  callModule(modTrackStats, 'dispTrackStats',
dmattek's avatar
dmattek committed
204
205
             in.data = in.data,
             in.bycols = in.facet)
dmattek's avatar
dmattek committed
206
207
  
  
dmattek's avatar
Mod:  
dmattek committed
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
  output$outPlotTraj <- renderPlot({
    
    loc.p = plotTraj()
    if(is.null(loc.p))
      return(NULL)
    
    return(loc.p)
  })
  
  
  output$outPlotTrajInt <- renderPlotly({
    # This is required to avoid
    # "Warning: Error in <Anonymous>: cannot open file 'Rplots.pdf'"
    # When running on a server. Based on:
    # https://github.com/ropensci/plotly/issues/494
    if (names(dev.cur()) != "null device")
      dev.off()
    pdf(NULL)
    
    loc.p = plotTraj()
    if(is.null(loc.p))
      return(NULL)
    
231
    return(ggplotly(loc.p))
dmattek's avatar
Mod:  
dmattek committed
232
233
234
235
236
237
238
  })
  
  
  
  # Trajectory plot - download pdf
  callModule(downPlot, "downPlotTraj", in.fname, plotTraj, TRUE)
  
dmattek's avatar
dmattek committed
239
  
dmattek's avatar
Mod:  
dmattek committed
240
241
242
243
244
245
246
247
248
249
  plotTraj <- function() {
    cat(file = stderr(), 'plotTraj: in\n')
    locBut = input$butPlotTraj
    
    if (locBut == 0) {
      cat(file = stderr(), 'plotTraj: Go button not pressed\n')
      
      return(NULL)
    }
    
250
    # check main data exists
dmattek's avatar
Mod:  
dmattek committed
251
252
253
254
255
256
257
258
259
    loc.dt = isolate(in.data())
    
    cat("plotTraj: on to plot\n\n")
    if (is.null(loc.dt)) {
      cat(file = stderr(), 'plotTraj: dt is NULL\n')
      return(NULL)
    }
    
    cat(file = stderr(), 'plotTraj: dt not NULL\n')
dmattek's avatar
dmattek committed
260
261
    
    
262
263
    # check if stim data exists
    loc.dt.stim = isolate(in.data.stim())
dmattek's avatar
dmattek committed
264
    
265
266
267
268
269
    if (is.null(loc.dt.stim)) {
      cat(file = stderr(), 'plotTraj: dt.stim is NULL\n')
    } else {
      cat(file = stderr(), 'plotTraj: dt.stim not NULL\n')
    }
dmattek's avatar
dmattek committed
270
    
dmattek's avatar
Mod:  
dmattek committed
271
272
273
    
    
    # Future: change such that a column with colouring status is chosen by the user
274
    # colour trajectories, if dataset contains mid.in column
dmattek's avatar
Mod:  
dmattek committed
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
    # with filtering status of trajectory
    if (sum(names(loc.dt) %in% 'mid.in') > 0)
      loc.line.col.arg = 'mid.in'
    else
      loc.line.col.arg = NULL
    
    # select every other point for plotting
    loc.dt = loc.dt[, .SD[seq(1, .N, input$sliPlotTrajSkip)], by = id]
    
    # check if columns with XY positions are present
    if (sum(names(loc.dt) %like% 'pos') == 2)
      locPos = TRUE
    else
      locPos = FALSE
    
290
291
292
293
294
295
296
297
    # check if column with ObjectNumber is present
    if (sum(names(loc.dt) %like% 'obj.num') == 1)
      locObjNum = TRUE
    else
      locObjNum = FALSE
    
    
    
dmattek's avatar
Fixed:    
dmattek committed
298
299
300
301
302
303
304
305
306
307
308
309
310
    # If in.facet.color present,
    # make sure to include the same number of colours in the palette,
    # as the number of groups in dt.
    # in.facet.color is typically used when plotting time series within clusters.
    # Then, the number of colours in the palette has to be equal to the number of clusters (facetted according to in.facet variable).
    # This might differ if the user selects manually clusters to display.
    if (is.null(in.facet.color)) 
      loc.facet.col = NULL 
    else {
      # get group numbers in dt; 
      # loc.dt[, c(in.facet), with = FALSE] returns a data table with a single column
      # [[1]] at the end extracts the first column and returns as a vector
      loc.groups = unique(loc.dt[, c(in.facet), with = FALSE][[1]])
dmattek's avatar
dmattek committed
311
      
dmattek's avatar
Fixed:    
dmattek committed
312
313
314
315
316
317
      # get colour palette
      # the length is equal to the number of groups in the original dt.
      # When plotting time series within clusters, the length equals the number of clusters.
      loc.facet.col = in.facet.color()$cl.col
      loc.facet.col = loc.facet.col[loc.groups]
    }
dmattek's avatar
dmattek committed
318
319
320
321
322
323
    
    
    loc.xlim.arg = NULL
    if(input$chBsetXbounds) {
      loc.xlim.arg = c(input$inSetXboundsLow, input$inSetXboundsHigh)
    } 
dmattek's avatar
Fixed:    
dmattek committed
324
    
dmattek's avatar
dmattek committed
325
326
327
328
329
    loc.ylim.arg = NULL
    if(input$chBsetYbounds) {
      loc.ylim.arg = c(input$inSetYboundsLow, input$inSetYboundsHigh)
    } 
    
330
    p.out = LOCplotTraj(
dmattek's avatar
Mod:  
dmattek committed
331
332
333
334
335
336
      dt.arg = loc.dt,
      x.arg = 'realtime',
      y.arg = 'y',
      group.arg = "id",
      facet.arg = in.facet,
      facet.ncol.arg = input$inPlotTrajFacetNcol,
337
338
339
      facet.color.arg = loc.facet.col, 
      dt.stim.arg = loc.dt.stim, 
      x.stim.arg = c('tstart', 'tend'),
dmattek's avatar
dmattek committed
340
341
      y.stim.arg = c('ystart', 'yend'), 
      stim.bar.width.arg = 1,
342
      xlab.arg = 'Time',
dmattek's avatar
Mod:  
dmattek committed
343
344
345
      line.col.arg = loc.line.col.arg,
      aux.label1 = if (locPos) 'pos.x' else NULL,
      aux.label2 = if (locPos) 'pos.y' else NULL,
346
      aux.label3 = if (locObjNum) 'obj.num' else NULL,
347
      stat.arg = input$chBPlotTrajStat,
dmattek's avatar
dmattek committed
348
349
      ylim.arg = loc.ylim.arg,
      xlim.arg = loc.xlim.arg
dmattek's avatar
Mod:  
dmattek committed
350
351
352
353
354
    )
    
    return(p.out)
  }
}