-
Notifications
You must be signed in to change notification settings - Fork 32
/
MultiAssayExperiment-helpers.R
868 lines (799 loc) · 32.8 KB
/
MultiAssayExperiment-helpers.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
#' @include MultiAssayExperiment-methods.R
NULL
#' @name MultiAssayExperiment-helpers
#'
#' @title A group of helper functions for manipulating and cleaning a
#' MultiAssayExperiment
#'
#' @aliases intersectRows intersectColumns mergeReplicates replicated
#' complete.cases,MultiAssayExperiment-method
#'
#' @description A set of helper functions were created to help clean and
#' manipulate a MultiAssayExperiment object. \code{intersectRows} also works
#' for \code{ExperimentList} objects.
#'
#' \itemize{
#' \item complete.cases: Returns a logical vector corresponding to 'colData'
#' rows that have data across all experiments
#' \item isEmpty: Returns a logical \code{TRUE} value for zero length
#' \code{MultiAssayExperiment} objects
#' \item intersectRows: Takes all common rows across experiments,
#' excludes experiments with empty rownames
#' \item intersectColumns: A wrapper for \code{complete.cases} to return a
#' \code{MultiAssayExperiment} with only those biological units that have
#' measurements across all experiments
#' \item replicated: Identifies, via logical vectors, \code{colname}s that
#' originate from a single biological unit within each assay
#' \item replicates: Provides the replicate \code{colname}s found with
#' the \code{replicated} function by their name, empty list if none
#' \item anyReplicated: Whether the assay has replicate measurements
#' \item showReplicated: Displays the actual columns that are replicated per
#' assay and biological unit, i.e., \code{primary} value (\code{colData}
#' rowname) in the \code{sampleMap}
#' \item mergeReplicates: A function that combines replicated / repeated
#' measurements across all experiments and is guided by the replicated
#' return value
#' \item longFormat: A \code{MultiAssayExperiment} method that
#' returns a small and skinny \link{DataFrame}. The \code{colDataCols}
#' arguments allows the user to append \code{colData} columns to the data.
#' \item wideFormat: A function to reshape the data in a
#' `MultiAssayExperiment` to a "wide" format \link{DataFrame}. Each row in
#' the `DataFrame` represents an observation (corresponding to an entry in
#' the `colData`). If replicates are present, their data will be appended at
#' the end of the corresponding row and will generate additional `NA` data.
#' It is recommended to remove or consolidate technical replicates with
#' `mergeReplicates`. Optional \code{colDataCols} can be added when the
#' original object is a \code{MultiAssayExperiment}.
#' \item hasRowRanges: A function that identifies ExperimentList elements
#' that have a \link[=RangedSummarizedExperiment-class]{rowRanges} method
#' \item getWithColData: A convenience function for extracting an assay
#' and associated colData
#' \item renamePrimary: A convenience function to rename the primary
#' biological units as represented in the \code{rownames(colData)}
#' \item renameColname: A convenience function to rename the colnames
#' of a particular assay
#' }
#'
#' @param x A MultiAssayExperiment or ExperimentList
#'
#' @param ... Additional arguments. See details for more information.
#'
#' @return See the itemized list in the description section for details.
#'
#' @md
#'
#' @examples
#'
#' example(MultiAssayExperiment)
#'
#' complete.cases(mae)
#'
#' isEmpty(MultiAssayExperiment())
#'
#' @exportMethod complete.cases
setMethod("complete.cases", "MultiAssayExperiment", function(...) {
args <- list(...)
if (length(args) == 1L) {
oldMap <- sampleMap(args[[1L]])
listMap <- mapToList(oldMap)
allPrimary <- Reduce(intersect,
lapply(listMap, function(element) { element[["primary"]] }))
rownames(colData(args[[1L]])) %in% allPrimary
} else { stop("Provide only a 'MultiAssayExperiment'") }
})
#' @rdname MultiAssayExperiment-helpers
#' @exportMethod isEmpty
setMethod("isEmpty", "MultiAssayExperiment", function(x) length(x) == 0L)
#' @rdname MultiAssayExperiment-helpers
#' @export
intersectRows <- function(x) {
rows <- rownames(x)
validRows <- Filter(length, rows)
intRows <- Reduce(intersect, validRows)
if (is(x, "MultiAssayExperiment"))
x[intRows, , drop = FALSE]
else if (is(x, "ExperimentList"))
x[CharacterList(rep(list(intRows), length(validRows)))]
else
stop("Provide a valid class: ", class(x))
}
#' @rdname MultiAssayExperiment-helpers
#' @export
intersectColumns <- function(x) {
comps <- complete.cases(x)
x[, comps, drop = FALSE]
}
#' @rdname MultiAssayExperiment-helpers
#' @export
setGeneric("replicated", function(x) standardGeneric("replicated"))
#' @rdname MultiAssayExperiment-helpers
#'
#' @details The \code{replicated} function finds replicate measurements in each
#' assay and returns a list of \linkS4class{LogicalList}s.
#' Each element in a single \linkS4class{LogicalList} corresponds to a
#' biological or \emph{primary} unit as in the \code{sampleMap}. Below is a
#' small graphic for one particular biological unit in one assay, where the
#' logical vector corresponds to the number of measurements/samples in the
#' assay:
#' \preformatted{
#' > replicated(MultiAssayExperiment)
#' (list str) '-- $ AssayName
#' (LogicalList str) '-- [[ "Biological Unit" ]]
#' Replicated if sum(...) > 1 '-- TRUE TRUE FALSE FALSE
#' }
#' \code{anyReplicated} determines if any of the assays have at least one
#' replicate. \emph{Note}. These methods are not available for the
#' \code{ExperimentList} class due to a missing \code{sampleMap} structure
#' (by design).
#' \code{showReplicated} returns a list of \linkS4class{CharacterList}s where
#' each element corresponds to the the biological or \emph{primary} units that
#' are replicated in that assay element. The values in the inner list are
#' the \code{colnames} in the assay that are technical replicates.
#'
#' @export
setMethod("replicated", "MultiAssayExperiment", function(x) {
listMap <- mapToList(sampleMap(x))
lapply(listMap, function(assayDF) {
pnames <- assayDF[["primary"]]
IRanges::LogicalList(lapply(
S4Vectors::splitAsList(pnames, pnames),
function(g) {
if (identical(length(g), 1L))
rep(FALSE, length(pnames))
else
pnames %in% g
}
))
})
})
#' @rdname MultiAssayExperiment-helpers
#' @export
setGeneric("anyReplicated", function(x) standardGeneric("anyReplicated"))
#' @rdname MultiAssayExperiment-helpers
#' @exportMethod anyReplicated
setMethod("anyReplicated", "MultiAssayExperiment", function(x) {
reps <- replicated(x)
vapply(reps, function(x) any(as.matrix(x)), logical(1L))
})
#' @rdname MultiAssayExperiment-helpers
#' @export
setGeneric("showReplicated", function(x) standardGeneric("showReplicated"))
#' @rdname MultiAssayExperiment-helpers
#' @exportMethod showReplicated
setMethod("showReplicated", "MultiAssayExperiment", function(x) {
clnames <- Filter(length, colnames(x))
replicates <- replicated(x)[names(clnames)]
Map(
function(y, z) {
IRanges::CharacterList(
Filter(length, lapply(z, function(g) y[g]))
)
},
y = clnames,
z = replicates
)
})
#' @rdname MultiAssayExperiment-helpers
#' @export
setGeneric("replicates", function(x, ...) standardGeneric("replicates"))
#' @rdname MultiAssayExperiment-helpers
#'
#' @details The \code{replicates} function (noun) returns the \code{colname}s
#' from the \code{sampleMap} that were identified as replicates. It returns a
#' list of \linkS4class{CharacterList}s for each assay present in the
#' \code{MultiAssayExperiment} and an inner entry for each biological unit
#' that has replicate observations in that assay.
#'
#' @export
setMethod("replicates", "MultiAssayExperiment", function(x, ...) {
listMap <- mapToList(sampleMap(x))
lapply(
X = listMap,
FUN = function(assayDF) {
Filter(
f = function(y) {
length(y) > 1
},
x = S4Vectors::splitAsList(
assayDF[["colname"]], assayDF[["primary"]]
)
)
}
)
})
# mergeReplicates function ------------------------------------------------
#' @rdname MultiAssayExperiment-helpers
#' @export
setGeneric("mergeReplicates",
function(x, replicates = list(), simplify = BiocGenerics::mean, ...)
standardGeneric("mergeReplicates"))
#' @rdname MultiAssayExperiment-helpers
#'
#' @details The \code{mergeReplicates} function is a house-keeping method
#' for a \code{MultiAssayExperiment} where only \code{complete.cases} are
#' returned. This by-assay operation averages replicate measurements
#' (by default) and columns are aligned by the row order in \code{colData}.
#' Users can provide their own function for merging replicates with the
#' \code{simplify} functional argument. Additional inputs \code{\ldots} are
#' sent to the 'simplify' function.
#'
#' @section mergeReplicates:
#' The \code{mergeReplicates} function makes use of the output from
#' \code{replicated} which will point out the duplicate measurements by
#' biological unit in the \code{MultiAssayExperiment}. This function will
#' return a \code{MultiAssayExperiment} with merged replicates. Additional
#' arguments can be provided to the simplify argument via the ellipsis
#' (\ldots). For example, when replicates "TCGA-B" and "TCGA-A" are found in
#' the assay, the name of the first appearing replicate is taken (i.e., "B").
#' Note that a typical use case of merging replicates occurs when there are
#' multiple measurements on the \strong{same} sample (within the same assay)
#' and can therefore be averaged.
#'
#' @param replicates A list of \linkS4class{LogicalList}s
#' indicating multiple / duplicate entries for each biological unit per assay,
#' see \code{replicated} (default \code{replicated(x)}).
#' @param simplify A function for merging repeat measurements in experiments
#' as indicated by the \code{replicated} method for \code{MultiAssayExperiment}
#'
#' @exportMethod mergeReplicates
setMethod("mergeReplicates", "MultiAssayExperiment",
function(x, replicates = replicated(x), simplify = BiocGenerics::mean, ...)
{
if (!length(replicates) || !identical(length(replicates), length(x)))
stop("'replicates' must be a list of technical replicates for each",
"\n biological unit. See '?replicated'.")
experimentList <- mergeReplicates(
x = experiments(x),
replicates = replicates,
simplify = simplify, ...)
experiments(x) <- experimentList
x
})
#' @describeIn ExperimentList Apply the mergeReplicates method on the
#' ExperimentList elements
#'
#' @param replicates mergeReplicates: A \code{list} or \linkS4class{LogicalList}
#' where each element represents a sample and a vector of repeated measurements
#' for the sample
#'
#' @param simplify A function for merging columns where duplicates are indicated
#' by replicates
#'
#' @param ... Additional arguments. See details for more information.
setMethod("mergeReplicates", "ExperimentList",
function(x, replicates = list(), simplify = BiocGenerics::mean, ...) {
if (!length(replicates))
stop("'replicates' must be a 'list' of replicated column elements",
"\n per biological unit")
expnames <- .setNames(names(x), names(x))
redList <- lapply(expnames,
function(i, element, simply, replicate, ...) {
mergeReplicates(x = element[[i]], simplify = simply,
replicates = replicate[[i]], ...)
}, element = x, simply = simplify, replicate = replicates, ...)
ExperimentList(redList)
}
)
#' @rdname MultiAssayExperiment-helpers
#'
#' @details The \code{mergeReplicates} "ANY" method consolidates duplicate
#' measurements for rectangular data structures, returns object of the same
#' class (endomorphic). The ellipsis or \code{\ldots} argument allows the
#' user to provide additional arguments to the \code{simplify} functional
#' argument.
setMethod("mergeReplicates", "ANY",
function(x, replicates = list(), simplify = BiocGenerics::mean, ...) {
object <- x
if (is.list(replicates))
replicates <- IRanges::LogicalList(replicates)
if (is(object, "SummarizedExperiment"))
x <- assay(object)
if (is(object, "ExpressionSet"))
x <- Biobase::exprs(object)
if (any(any(replicates))) {
uniqueCols <- apply(as.matrix(replicates), 2, function(cols) {
!any(cols)
})
repeatList <- lapply(replicates, function(reps, rectangle) {
if (any(reps)) {
repNames <- colnames(rectangle)[reps]
baseList <- as(split(rectangle[, repNames],
seq_len(nrow(x))), "List")
result <- simplify(baseList, ...)
result <- matrix(result, ncol = 1,
dimnames = list(NULL, repNames[[1L]]))
return(result)
}
}, rectangle = x)
uniqueRectangle <- do.call(cbind, unname(repeatList))
result <- cbind(uniqueRectangle, x[, uniqueCols, drop = FALSE])
if (is(object, "SummarizedExperiment")) {
# Keep only first replicate row in colData
colDatIdx <- c(unname(min(which(replicates[any(replicates)]))),
which(uniqueCols))
newColDat <- colData(object)[colDatIdx, , drop = FALSE]
object <- initialize(object,
assays = Assays(SimpleList(result)), colData = newColDat)
} else if (is(object, "ExpressionSet")) {
# phenoData of ExpressionSet is lost
object <- initialize(object, exprs = result)
} else
return(result)
}
return(object)
})
# longFormat function -----------------------------------------------------
.longFormatANY <- function(object, i) {
rowNAMES <- rownames(object)
nullROWS <- is.null(rowNAMES)
if (nullROWS)
rowNAMES <- as.character(seq_len(nrow(object)))
if (is(object, "ExpressionSet"))
object <- Biobase::exprs(object)
if (is(object, "SummarizedExperiment") || is(object, "RaggedExperiment"))
object <- assay(object, i = i)
if (is(object, "matrix"))
object <- as.data.frame(object)
## use stats::reshape instead of reshape2::melt
if (nullROWS)
rownames(object) <- rowNAMES
object <- stats::reshape(object, idvar = "rowname",
ids = rownames(object), times = names(object),
timevar = "colname", varying = list(names(object)),
direction = "long", v.names = "value")
## Reshape leaves rownames even if new.row.names = NULL
rownames(object) <- NULL
object[, c("rowname", "colname", "value")]
}
.longFormatElist <- function(object, i) {
if (!is(object, "ExperimentList"))
stop("<internal> Not an 'ExperimentList' input")
samelength <- identical(length(object), length(i))
if (!samelength && identical(length(i), 1L))
i <- rep(i, length(object))
mapply(function(obj, obname, idx) {
data.frame(assay = obname, .longFormatANY(obj, i = idx),
stringsAsFactors = FALSE)
}, obj = object, obname = names(object), idx = i, SIMPLIFY = FALSE)
}
.matchAddColData <- function(reshaped, colData, colDataCols) {
extraColumns <- as.data.frame(colData[, colDataCols, drop = FALSE])
rowNameValues <- rownames(extraColumns)
rownames(extraColumns) <- NULL
matchIdx <- match(reshaped[["primary"]], rowNameValues)
matchedDF <- extraColumns[matchIdx, , drop = FALSE]
rownames(matchedDF) <- NULL
cbind(reshaped, matchedDF)
}
.mapOrderPrimary <- function(flatbox, samplemap) {
primary <- samplemap[match(flatbox[["colname"]], samplemap[["colname"]]),
"primary"]
reshaped <- data.frame(flatbox, primary = primary,
stringsAsFactors = FALSE)
reshaped[, c("assay", "primary", "rowname", "colname", "value")]
}
#' @rdname MultiAssayExperiment-helpers
#'
#' @aliases longFormat
#'
#' @details The \code{longFormat} "ANY" class method, works with classes such as
#' \link{ExpressionSet} and \link{SummarizedExperiment} as well as \code{matrix}
#' to provide a consistent long and skinny \link{DataFrame}.
#'
#' @section longFormat:
#' The 'longFormat' method takes data from the \code{\link{ExperimentList}}
#' in a \code{\link{MultiAssayExperiment}} and returns a uniform
#' \code{\link{DataFrame}}. The resulting DataFrame has columns indicating
#' primary, rowname, colname and value. This method can optionally include
#' columns of the MultiAssayExperiment colData named by \code{colDataCols} character
#' vector argument. (\code{MultiAssayExperiment} method only). The \code{i} argument
#' allows the user to specify the assay value for the
#' \linkS4class{SummarizedExperiment} assay function's \code{i} argument.
#'
#' @param object Any supported class object
#'
#' @param colDataCols A \code{character}, \code{logical}, or \code{numeric}
#' index for \code{colData} columns to be included
#'
#' @param i longFormat: The i-th assay in
#' \linkS4class{SummarizedExperiment}-like objects. A vector input is
#' supported in the case that the SummarizedExperiment object(s) has more
#' than one assay (default 1L),
#' renameColname: Either a \code{numeric} or \code{character} index
#' indicating the assay whose colnames are to be renamed
#'
#' @param mode String indicating how \linkS4class{MultiAssayExperiment}
#' column-level metadata should be added to the
#' \linkS4class{SummarizedExperiment} \code{colData}.
#'
#' @export longFormat
longFormat <- function(object, colDataCols = NULL, i = 1L) {
if (is(object, "ExperimentList"))
return(do.call(rbind, .longFormatElist(object, i = i)))
else if (!is(object, "MultiAssayExperiment"))
return(.longFormatANY(object, i = i))
if (any(.emptyAssays(experiments(object))))
object <- .dropEmpty(object, warn = FALSE)
longDataFrame <- do.call(function(...) rbind(..., make.row.names = FALSE),
.longFormatElist(experiments(object), i = i))
longDataFrame <- .mapOrderPrimary(longDataFrame, sampleMap(object))
if (!is.null(colDataCols))
longDataFrame <-
.matchAddColData(longDataFrame, colData(object), colDataCols)
as(longDataFrame, "DataFrame")
}
# wideformat function -----------------------------------------------------
.wideFormatANY <- function(object, i, check.names) {
if (is(object, "ExpressionSet"))
object <- Biobase::exprs(object)
if (is.matrix(object) && is.null(rownames(object)))
rownames(object) <- as.character(seq_len(object))
if (!is.null(rownames(object)) && !is(object, "SummarizedExperiment"))
object <- data.frame(rowname = rownames(object), object,
stringsAsFactors = FALSE, check.names = check.names,
row.names = NULL)
if (is(object, "SummarizedExperiment")) {
## Ensure that rowData DataFrame has a rowname column
## Otherwise, use the rownames or first column
rowDatNames <- names(rowData(object))
rownameIn <- "rowname" %in% rowDatNames
rowNAMES <- rownames(object)
if (any(rownameIn)) {
rowData(object) <- rowData(object)[rownameIn]
} else if (!is.null(rowNAMES) || !length(rowDatNames)) {
rowData(object) <- S4Vectors::DataFrame(rowname = rowNAMES)
} else {
warning("'rowname' column not in 'rowData' taking first one")
rowData(object) <- rowData(object)[1L]
names(rowData(object)) <- "rowname"
}
assayDat <- assay(object, i = i)
object <- data.frame(rowname = rowData(object), assayDat,
stringsAsFactors = FALSE, check.names = check.names,
row.names = NULL)
}
object
}
.metadataCOLS <- function(metcols, collapser, coldatcols) {
namesList <- lapply(strsplit(metcols, collapser), `[`)
sqnames <- lapply(namesList, function(nam)
append(nam, rep(NA_character_, 3L - length(nam))))
doFrame <- do.call(rbind.data.frame, sqnames)
names(doFrame) <- c("sourceName", "rowname", "colname")
doFrame[["sourceName"]] <-
gsub("primary", "colDataRows", doFrame[["sourceName"]])
doFrame[doFrame[["sourceName"]] %in% coldatcols, "sourceName"] <-
"colDataCols"
doFrame
}
#' @rdname MultiAssayExperiment-helpers
#'
#' @section wideFormat:
#' The \code{wideFormat} function returns standardized wide \link{DataFrame}
#' where each row represents a biological unit as in the \code{colData}.
#' Depending on the data and setup, biological units can be patients, tumors,
#' specimens, etc. Metadata columns are
#' generated based on the names produced in the wide format
#' \linkS4class{DataFrame}. These can be accessed via the
#' \link[=Vector-class]{mcols} function.
#' See the \code{wideFormat} section for description of the \code{colDataCols} and
#' \code{i} arguments.
#'
#' @param check.names (logical default TRUE) Column names of the output
#' \code{DataFrame} will be checked for syntactic validity and made unique,
#' if necessary
#'
#' @param collapse (character default "_") A single string delimiter for output
#' column names. In \code{wideFormat}, experiments and rownames (and when
#' replicate samples are present, colnames) are seperated by this delimiter
#'
#' @export wideFormat
wideFormat <- function(object, colDataCols = NULL, check.names = TRUE,
collapse = "_", i = 1L) {
collSymbol <- "///"
key <- "feature"
if (any(.emptyAssays(experiments(object))))
object <- .dropEmpty(object, warn = FALSE)
if (is.null(colDataCols)) colDataCols <- character(0L)
nameFUN <- if (check.names) make.names else I
cnames <- colnames(object)
longList <- .longFormatElist(experiments(object), i = i)
longList <- lapply(longList, .mapOrderPrimary, sampleMap(object))
colsofinterest <- c("assay", "rowname")
anyReps <- anyReplicated(object)
if (any(anyReps)) {
indx <- names(which(anyReps))
dups <- replicated(object)[indx]
lVects <- lapply(indx, function(expname, duplic) {
logilist <- duplic[[expname]]
lmat <- as.matrix(logilist)
rownames(lmat) <- names(logilist)
colnames(lmat) <- cnames[[expname]]
lData <- longList[[expname]][, c("primary", "colname")]
apply(lData, 1L, function(x) lmat[x[1L], x[2L]])
}, duplic = dups)
repList <- Map(function(x, y) { x[y, , drop = FALSE] },
x = longList[indx], y = lVects)
longList[indx] <- Map(function(x, y) { x[!y, , drop = FALSE] },
x = longList[indx], y = lVects)
longList <- lapply(longList, function(x)
tidyr::unite(x[, names(x) != "colname"], col = !!key,
colsofinterest, sep = collSymbol)
)
repList <- lapply(repList, function(x)
tidyr::unite(x, col = !!key, c(colsofinterest, "colname"),
sep = collSymbol))
wideData <- c(longList, repList)
} else {
wideData <- lapply(longList, function(x)
tidyr::unite(x[, names(x) != "colname"], col = !!key,
colsofinterest, sep = collSymbol))
}
wideData <- lapply(wideData, function(flox) {
flox <- tidyr::pivot_wider(flox, names_from = key)
.matchAddColData(flox, colData(object), colDataCols)
})
wideDF <- Reduce(function(x, y)
merge(x, y, by = intersect(names(x), names(y)), all = TRUE), wideData)
wideDF <- as(wideDF, "DataFrame")
metadat <- .metadataCOLS(names(wideDF), collSymbol, colDataCols)
mcols(wideDF) <- metadat
names(wideDF) <- nameFUN(gsub(collSymbol, collapse, names(wideDF)))
wideDF[order(match(wideDF[["primary"]], rownames(colData(object)))), ]
}
# hasRowRanges section ----------------------------------------------------
.tryRowRanges <- function(obj) {
res <- try(rowRanges(obj), silent = TRUE)
if (!is(res, "try-error"))
is(res, "GRanges")
else
FALSE
}
#' @rdname MultiAssayExperiment-helpers
#'
#' @aliases hasRowRanges
#'
#' @section hasRowRanges:
#' The \code{hasRowRanges} method identifies assays with associated ranged
#' row data by directly testing the method on the object. The result from the
#' test must be a \linkS4class{GRanges} class object to satisfy the test.
#'
#' @export hasRowRanges
setGeneric("hasRowRanges", function(x) standardGeneric("hasRowRanges"))
#' @rdname MultiAssayExperiment-helpers
#'
#' @details The \code{hasRowRanges} method identifies assays that support
#' a \link[=RangedSummarizedExperiment-class]{rowRanges} method \emph{and}
#' return a \linkS4class{GRanges} object.
setMethod("hasRowRanges", "MultiAssayExperiment", function(x) {
hasRowRanges(experiments(x))
})
#' @rdname MultiAssayExperiment-helpers
#' @exportMethod hasRowRanges
setMethod("hasRowRanges", "ExperimentList", function(x) {
vapply(x, .tryRowRanges, logical(1L))
})
#' @rdname MultiAssayExperiment-helpers
#'
#' @param verbose logical(1) Whether to `suppressMessages` on subsetting
#' operations in `getWithColData` (default FALSE)
#'
#' @aliases getWithColData
#'
#' @section getWithColData:
#' The \code{getWithColData} function allows the user to conveniently extract
#' a particular assay as indicated by the \strong{\code{i}} index argument. It
#' will also attempt to provide the
#' \code{\link[=SummarizedExperiment-class]{colData}} along with the
#' extracted object using the \code{colData<-} replacement
#' method when possible. Typically, this method is available for
#' \linkS4class{SummarizedExperiment} and \code{RaggedExperiment}
#' classes.
#'
#' The setting of \code{mode} determines how the \code{\link{colData}}
#' is added. If \code{mode="append"}, the \linkS4class{MultiAssayExperiment}
#' metadata is appended onto that of the \linkS4class{SummarizedExperiment}.
#' If any fields are duplicated by name, the values in the
#' \linkS4class{SummarizedExperiment} are retained, with a warning emitted if
#' the values are different. For \code{mode="replace"}, the
#' \linkS4class{MultiAssayExperiment} metadata replaces that of the
#' \linkS4class{SummarizedExperiment}, while for \code{mode="none"},
#' no replacement or appending is performed.
#'
#' @export getWithColData
getWithColData <- function(x, i, mode=c("append", "replace"), verbose = FALSE) {
if (!is(x, "MultiAssayExperiment"))
stop("Provide a MultiAssayExperiment as input")
stopifnot(is.numeric(i) || is.character(i),
identical(length(i), 1L), !is.na(i), !is.logical(i),
is.character(mode), !is.na(mode), !is.logical(mode))
FUN <- if (!verbose) suppressMessages else force
mae <- FUN(x[, , i, drop = FALSE])
prims <- sampleMap(mae)[["primary"]]
if (anyDuplicated(prims))
warning("Duplicating colData rows due to replicates in 'replicated(x)'",
call. = FALSE)
expanded <- colData(mae)[prims, , drop = FALSE]
exObj <- mae[[1L]]
tryCatch({
existing <- colData(exObj)
}, error = function(e) {
stop(
"Extracted class does not support 'colData':",
"\n ", conditionMessage(e), call. = FALSE
)
})
mode <- match.arg(mode)
if (identical(mode, "replace") || !length(existing))
colData(exObj) <- expanded
else if (identical(mode, "append")) {
# Prune out duplicate entries
common <- intersect(colnames(existing), colnames(expanded))
if (length(common)) {
warnid <- vapply(common, function(varname, x, y) {
!identical(x[[varname]], y[[varname]])
}, logical(1L), x = existing, y = expanded)
.warning(
"Ignoring redundant column names in 'colData(x)': ",
paste(common[warnid], collapse = ", ")
)
}
leftovers <- expanded[, setdiff(colnames(expanded), common), drop=FALSE]
colData(exObj) <- cbind(existing, leftovers)
}
exObj
}
#' @rdname MultiAssayExperiment-helpers
#'
#' @aliases renamePrimary
#'
#' @section rename*:
#' The \code{renamePrimary} function allows the user to conveniently change the
#' actual names of the primary biological units as seen in
#' \code{rownames(colData)}. \code{renameColname} allows the user to change the
#' names of a particular assay based on index \code{i}. \code{i} can either be
#' a single numeric or character value. See \code{colnames<-} method for
#' renaming multiple colnames in a \code{MultiAssayExperiment}.
#'
#' @param value renamePrimary: A \code{character} vector of the same length as
#' the existing \code{rownames(colData)} to use for replacement,
#' renameColname: A \code{CharacterList} or \code{list} with matching
#' \code{lengths} to replace \code{colnames(x)}
#'
#' @examples
#'
#' ## renaming biological units (primary)
#'
#' mae2 <- renamePrimary(mae, paste0("pt", 1:4))
#' colData(mae2)
#' sampleMap(mae2)
#'
#' @export renamePrimary
renamePrimary <- function(x, value) {
coldata <- colData(x)
old <- rownames(coldata)
if (length(old) != length(value))
stop("'value' length does not match 'length(rownames(colData))'")
samplemap <- sampleMap(x)
nprime <- value[match(samplemap[["primary"]], old)]
samplemap[["primary"]] <- nprime
rownames(coldata) <- value
BiocBaseUtils::setSlots(
object = x,
sampleMap = samplemap,
colData = coldata
)
}
#' @rdname MultiAssayExperiment-helpers
#'
#' @aliases renameColname
#'
#' @examples
#'
#' ## renaming observational units (colname)
#'
#' mae2 <- renameColname(mae, i = "Affy", paste0("ARRAY", 1:4))
#' colnames(mae2)
#' sampleMap(mae2)
#'
#'
#' @export renameColname
renameColname <- function(x, i, value) {
stopifnot(length(i) == 1L, !is.na(i), !missing(i))
exps <- experiments(x)
expAssay <- x[[i]]
splitmp <- mapToList(sampleMap(x))
expmap <- splitmp[[i]]
old <- expmap[["colname"]]
if (length(old) != length(value))
stop("'value' length does not match 'length(colnames(x[[i]]))'")
newcns <- value[match(expmap[["colname"]], old)]
expmap[["colname"]] <- newcns
splitmp[[i]] <- expmap
smp <- listToMap(splitmp)
colnames(expAssay) <- value
exps[[i]] <- expAssay
BiocBaseUtils::setSlots(
object = x,
sampleMap = smp,
ExperimentList = exps
)
}
#' @rdname MultiAssayExperiment-helpers
#'
#' @aliases splitAssays
#'
#' @section splitAssays:
#' The \code{splitAssays} method separates columns in each of the assays based
#' on the \code{hitList} input. The \code{hitList} can be generated using
#' the \code{makeHitList} helper function. To use the \code{makeHitList}
#' helper, the user should input a list of patterns that will match on the
#' column names of each assay. These matches should be mutually exclusive as
#' to avoid repetition of columns across assays. See the examples section.
#'
#' @param hitList a named \code{list} or \code{List} of logical vectors that
#' indicate groupings in the assays
#'
#' @param patternList a named \code{list} or \code{List} of atomic character
#' vectors that are the input to \code{grepl} for identifying groupings in
#' the assays
#'
#' @export hasRowRanges
setGeneric("splitAssays", function(x, hitList)
standardGeneric("splitAssays")
)
#' @rdname MultiAssayExperiment-helpers
#' @exportMethod splitAssays
setMethod("splitAssays", "MultiAssayExperiment",
function(x, hitList) {
stopifnot(is.list(hitList) || is(hitList, "List"))
exps <- experiments(x)
innames <- lapply(hitList, names)
validENames <- unique(unlist(innames))
exps <- exps[names(exps) %in% validENames]
sublist <- lapply(hitList, function(logilist) {
Map(function(x, y) {
x[, y, drop = FALSE]
}, x = exps, y = logilist)
})
sublist <- unlist(sublist, recursive = FALSE)
names(sublist) <- gsub("\\.", "_", names(sublist))
names(x) <- names(sublist)
experiments(x) <- ExperimentList(sublist)
x
}
)
#' @rdname MultiAssayExperiment-helpers
#'
#' @aliases makeMatchList
#'
#' @examples
#'
#' patts <- list(
#' normals = "TCGA-[A-Z0-9]{2}-[A-Z0-9]{4}-11",
#' tumors = "TCGA-[A-Z0-9]{2}-[A-Z0-9]{4}-01"
#' )
#'
#' data("miniACC")
#'
#' hits <- makeHitList(miniACC, patts)
#'
#' ## only turmors present
#' splitAssays(miniACC, hits)
#'
#' @export
makeHitList <- function(x, patternList) {
Colnames <- colnames(x)
res <- lapply(
.setNames(nm = names(patternList)),
function(pattname, patt) {
grepl(patt[[pattname]], unlist(Colnames))
}, patt = patternList
)
reslist <- lapply(res, relist, Colnames)
sums <- do.call(function(...) Map(`+`, ...), reslist)
if (any(unlist(sums) > 1))
stop("Groupings are not mutually exclusive")
matching <- vapply(reslist, function(x) any(any(x)), logical(1L))
reslist[matching]
}