-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathrwgcna_functions_seurat3.0.R
2422 lines (2177 loc) · 115 KB
/
rwgcna_functions_seurat3.0.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
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Title: sc functions
# Author: Jonatan Thompson, Pers Lab
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
FilterGenes <- function(seurat_obj_sub, minGeneCells) {
if (minGeneCells > 0 & !is.null(dim(seurat_obj_sub@raw.data))) {
num.cells <- rowSums(seurat_obj_sub@raw.data > 0)
genes.use <- names(x = num.cells[which(x = num.cells >= minGeneCells)])
if (length(genes.use)>0) {
seurat_obj_sub@raw.data <- seurat_obj_sub@raw.data[genes.use, ]
} else {
seurat_obj_sub <- NULL
}
}
return(seurat_obj_sub)
}
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
wrapJackStraw = function(seurat_obj_sub,
nRepJackStraw,
pvalThreshold,
featuresUse,
nFeatures,
nPC) {
prop.freq <- max(0.016, round(4/length(VariableFeatures(seurat_obj_sub)),3)) # to ensure we have at least 3 samples so the algorithm works well
# see https://github.com/satijalab/seurat/issues/5
###
#pcs.compute = ncol(Loadings(seurat_obj_sub, reduction="pca"))
seurat_obj_sub <- tryCatch({
JackStraw(object = seurat_obj_sub,
reduction="pca",
dims = min(min(length(VariableFeatures(seurat_obj_sub))%/% 2, ncol(seurat_obj_sub) %/% 3), min(nPC,ncol(seurat_obj_sub@reductions$pca@feature.loadings))),#min(, min(length(VariableFeatures(seurat_obj_sub))%/% 2, ncol(seurat_obj_sub) %/% 2)),
num.replicate = nRepJackStraw,
verbose=F,
prop.freq = prop.freq)}, error= function(err) {
# Reduce number of dimensions (PCs) and increase prop.freq, the proportion of genes scrambled
JackStraw(object = seurat_obj_sub,
reduction="pca",
dims = min(min(length(VariableFeatures(seurat_obj_sub))%/% 4, ncol(seurat_obj_sub) %/% 4), min(nPC,ncol(seurat_obj_sub@reductions$pca@feature.loadings))),
num.replicate = nRepJackStraw,
verbose=F,
prop.freq = prop.freq*1.2)
}) # https://github.com/satijalab/seurat/issues/5
# Inserts p-values into seurat_obj_sub@reductions$pca@JackStraw$overall.p.values
# as a nPC * 2 matrix with colnames "PC" and "Score"
#seurat_obj_sub <- ScoreJackStraw(object = seurat_obj_sub, dims = 1:pcs.compute)
seurat_obj_sub <- ScoreJackStraw(object = seurat_obj_sub, dims = 1:nPC)
score.df <- seurat_obj_sub@reductions$pca@jackstraw$overall.p.values %>% as.data.frame
PC_select_idx <- which(score.df[["Score"]] < pvalThreshold)
# Get gene loading p values
pAll <- seurat_obj_sub@reductions$pca@jackstraw$empirical.p.values
# melt to long
pAll <- as.data.frame(pAll)
pAll$gene <- rownames(x = pAll)
pAll.l <- melt(data = pAll, id.vars = "gene")
colnames(x = pAll.l) <- c("gene", "PC", "Value")
if (featuresUse == 'JackStrawPCSignif') {
# Take genes that load significantly on a significant PC
row_min <- apply(pAll[,PC_select_idx, drop=F], MARGIN = 1, FUN = min)
vec_idxOrder <- order(row_min, na.last = T, decreasing = F)
vec_idxOrderSignif <- vec_idxOrder[row_min[vec_idxOrder]<pvalThreshold]
namesFeaturesUse <- rownames(pAll)[vec_idxOrderSignif][1:min(nFeatures, length(vec_idxOrderSignif))]
# If there are not enough significant gene loadings (e.g. due to too few reps)
# take max loadings instead
if (length(namesFeaturesUse<1000)) featuresUse = 'JackStrawPCLoading'
}
if (featuresUse=='JackStrawPCLoading') {
# Take max nFeatures loading genes, using only significant PCs
seurat_obj_sub <- ProjectDim(object=seurat_obj_sub,
reduction = "pca",
verbose=F,
overwrite=F)
loadingsAbs <- seurat_obj_sub@reductions$pca@feature.loadings.projected %>% abs
loadingsAbs <- loadingsAbs[,PC_select_idx] # only count loadings on significant PCs after JackStraw
apply(loadingsAbs, MARGIN=1, FUN=max) %>% sort(., decreasing=T) %>%
'['(1:(min(nFeatures, nrow(loadingsAbs)))) %>% names -> namesFeaturesUse
}
GetAssayData(object=seurat_obj_sub,slot = slotUse, assay = assayUse)[namesFeaturesUse,] %>% as.matrix %>% t -> datExpr
return(datExpr)
}
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# seurat_to_datExpr = function(seurat_obj_sub, idx_genes_use) {
# # Only if we don't use PCA loading genes
# datExpr <- seurat_obj_subscale.data[idx_genes_use,] %>% t()
# colnames(datExpr) <- rownames(seurat_obj_sub@scale.data[idx_genes_use,])
# return(datExpr)
# }
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
bootstrap <- function(datExpr,
nPermutations,
replace,
fraction,
randomSeed)
# @Usage: Resample a dataset.
# @args:
# datExpr: Dataset with samples in the rows, is coerced to matrix
# nPermutations: runs
# replace: sample with replacement?
# fraction: sample what fraction of the total each iteration?
# randomSeed: initial random seed
# @return:
# result: list of resampled datasets in matrix format. If replace = T, first item is the unpermuted dataset.
# @author: Jonatan Thompson jjt3f2188@gmail.com
# @date: 180222
{
startRunIndex = 1
endRunIndex = if (replace==T) nPermutations+1 else nPermutations
result = vector("list", length= if (replace==T) nPermutations+1 else nPermutations);
nSamples = nrow(datExpr);
nFeatures = ncol(datExpr);
try(
for (run in startRunIndex:endRunIndex)
{
#set.seed(randomSeed + 2*run + 1);
if (run == startRunIndex & replace == T) {
useSamples = c(1:nSamples) # The first run just returns the full dataset
} else if (run>startRunIndex | replace == F)
{ useSamples = sample(nSamples, as.integer(nSamples * fraction), replace = replace)
}
samExpr = as.matrix(datExpr[useSamples, ]);
result[[run]]$data <- samExpr
})
return(result)
}
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# refactored - no need for function here
# TOM_for_par = function(datExpr, subsetName, softPower, prefixData) {
#
# ### 180503 v1.7
# disableWGCNAThreads()
# ###
#
# adjacency = adjacency(datExpr,
# type=type,
# power = softPower,
# corFnc = corFnc,
# corOptions = corOptions)
#
# consTomDS = TOMsimilarity(adjMat=adjacency,
# TOMType=TOMType,
# TOMDenom=TOMDenom,
# verbose=verbose,
# indent = indent)
#
# save(consTomDS, file=sprintf("%s%s_%s_consensusTOM-block.1.RData", scratch_dir, prefixData, subsetName)) # Save TOM the way consensusTOM would have done
# goodGenesTOM_idx <- rep("TRUE", ncol(datExpr))
# return(goodGenesTOM_idx)
# }
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# dissTOM_for_par = function(subsetName, prefixData) {
# # We now use hierarchical clustering to produce a hierarchical clustering tree (dendrogram) of genes.
# # We use Dynamic Tree Cut from the package dynamicTreeCut.
# load(sprintf("%s%s_%s_consensusTOM-block.1.RData", scratch_dir, prefixData, subsetName)) # Load the consensus TOM generated by blockwiseConsensusModules
#
# dissTOM <- 1-as.dist(consTomDS) # Convert proximity to distance
# rm(consTomDS)
#
# return(dissTOM)
# }
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
cutreeHybrid_for_vec <- function(comb, geneTree, dissTOM, maxPamDist, useMedoids) {
# Utility function for more easily parallellising the cutreeHybrid function
tree = cutreeHybrid(dendro = geneTree,
cutHeight = NULL,
minClusterSize = comb[[1]],
distM=as.matrix(dissTOM),
deepSplit=comb[[2]],
pamStage=comb[[3]],
pamRespectsDendro=comb[[3]],
maxPamDist = maxPamDist,
useMedoids = useMedoids)
# Gandal et al 2018: cutHeight = 0.999
return(tree)
}
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
#
# mergeCloseModules_for_vec <- function(cutree,comb, datExpr, excludeGrey) {
# # Utility function for more easily parallelising mergeCloseModules
# # deprecated
# colors <- NULL
# MEs <- NULL
# tryCatch({
# merged = mergeCloseModules(exprData=as.matrix(datExpr),
# colors = cutree$labels,
# impute =T,
# corFnc = corFnc,
# corOptions = corOptions,
# cutHeight=comb[[4]],
# iterate = T,
# getNewMEs = F,
# getNewUnassdME = F)
#
#
# colors = labels2colors(merged$colors)
# #MEs = merged$newMEs
# MEs = moduleEigengenes_uv(expr = as.matrix(datExpr),
# colors=colors,
# excludeGrey = excludeGrey)
#
#
# }, error = function(c) {
# warning(paste0("MergeCloseModules failed"))
# })
# return(list("cols" = colors, "MEs"= MEs))
# }
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# extract_and_name_colors <- function(merged, datExpr) {
# colors <- merged[[1]]
# names(colors) = colnames(datExpr)
# return(colors)
# }
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
mergeCloseModskIM = function(datExpr,
colors,
kIMs,
dissTOM = NULL,
moduleMergeCutHeight,
verbose=2,
cellType) {
# Usage: compute correlations between gene module cell embeddings.
# merge modules with a positive correlation > 1-moduleMergeCutHeight
#
# Args: datExpr: a cell * gene expression matrix
# colors: vector module assignments with gene names
# kIMs: generalised IntraModular connectivity, dataframe of gene row and module column. Should not include the grey module
# dissTOM: only needed if iterate=T, in order to recompute kIMs
# cellModEmbed_mat: embedding matrix of cell rows and module columbs. Passing the matrix saves time; otherwise will be computed
# moduleMergeCutHeight: max distance (1-correlation coefficient) for merging modules
# verbose: verbosity of WGCNA::cor function, 1-5
#
# Returns: list with entries colors=colors_merged, kIMs = kIMs_merged
corr_clust <- character(length = length(unique(colors)))
colors_original <- colors
# Remove 'grey' (unassigned) module
#if (any(colnames(kIMs) == "grey")) kIMs[["grey"]] <- NULL
if (length(unique(colors)) > 1) { # if there is more than one non-grey module
while (TRUE) {
message(paste0(cellType, ": computing cell-module embedding matrix"))
cellModEmbed_mat <- cellModEmbed(datExpr=datExpr,
modcolors=colors,
latentGeneType = "IM",
cellType=NULL,
kMs=kIMs)
#cellModEmbed_mat <- cellModEmbed_mat[,-grep("^grey$", colnames(cellModEmbed_mat))]
# Cluster modules using the Pearson correlation between module cell embeddings
if (ncol(cellModEmbed_mat)<2) {
message(paste0(cellType, " done"))
break
}
mod_corr <- WGCNA::cor(x=cellModEmbed_mat, method=c("pearson"), verbose=verbose)
mod_corr[mod_corr<0] <- 0 #only keep positive correlations
corr_dist <- as.dist(m = (1-mod_corr), diag = F, upper = F) # convert to (1-corr) distance matrix
corr_dendro <- hclust(d = corr_dist, method = "average")
# use a simple cut to determine clusters
corr_clust = cutreeStatic(dendro = corr_dendro,
cutHeight = moduleMergeCutHeight,
minSize=1)
names(corr_clust) = corr_dendro$labels
# At this point if corr_clust has as many unique modules as the original partition, the while loop will exit
if(length(unique(corr_clust)) == length(unique(colors))) {
message(paste0(cellType, " done"))
break
}
# if not we merge modules
n_merge <- length(unique(colors)) - length(unique(corr_clust))
if (verbose>0) message(paste0(cellType, ": ", n_merge, " modules to be merged with others"))
merge_idx <- sapply(unique(corr_clust), function(x) sum(corr_clust==x)>1)
# merge modules
for (clust in unique(corr_clust)[merge_idx]) { # loop over numeric cluster assignments
new_color = names(corr_clust)[corr_clust==clust][1] # use the colors name of the first module in the cluster
for (color in names(corr_clust[corr_clust==clust])) { # loop over all module colors in the cluster
colors[colors==color] <- new_color # give them all the new colour
}
}
# compute merged module kIMs
message(paste0("Computing merged module kIMs for ", cellType))
# Compute new kIMs
kIMs <- kIM_eachMod_norm(dissTOM = dissTOM,
colors = colors,
verbose = 1,
excludeGrey = F)
}
names(colors) = names(colors_original)
}
return(list(colors=colors, kIMs = kIMs))
}
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# parGetColors = function(list_merged, datExpr) {
# list_colors = lapply(list_merged, function(x) extract_and_name_colors(merged=x, datExpr=datExpr)) # list of merged colors
# return(list_colors)
# }
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# parMatchColors <- function(list_colors) {
# # Inherits n_combs from the parent environment, same for every subsetName, no need to pass as an argument
#
# if (length(list_colors)>1) {
# # Match colors between iterations by reference to the set of colors with the highest number of unique colors
# max_colors_idx = which.max(lapply(list_colors, function(x) length(table(x))))
#
# diffParams_colors = matrix(0, nrow=length(list_colors[[1]]), ncol=n_combs)
# diffParams_colors[, max_colors_idx] = list_colors[[max_colors_idx]] # use the set of colors with the highest number of modules as 'reference'
#
# for (j in (1:n_combs)[-max_colors_idx]) {
# if (length(table(list_colors[[j]])) > 1) {
# diffParams_colors[,j] <- matchLabels(source = list_colors[[j]], # traverse gene colour assignments
# reference = diffParams_colors[,max_colors_idx],
# pThreshold = 5e-2,
# na.rm = TRUE,
# extraLabels = standardColors())#paste0("Extra_", 0:500)) # labels for modules in source that cannot be matched to any modules in reference
#
# } else if (length(table(list_colors[[j]])) == 1) {
# diffParams_colors[,j] <- "grey"
# }
# }
# # Split the matrix of matched colors back into a list
# list_colors_matched <- split(diffParams_colors, rep(1:ncol(diffParams_colors), each = nrow(diffParams_colors)))
#
# } else if (length(list_colors)==1) {
# diffParams_colors <- as.matrix(list_colors[[1]], nrow=length(list_colors[[1]]), ncol=1)
# list_colors_matched <- list_colors
# }
#
#
#
# return(list_colors_matched)
#
# }
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# parkMEs = function(list_MEs, datExpr, cellCluster) {
# list_kMEs <- NULL
# tryCatch({
# # Compute kMEs and pkMEs for each set of colors corresponding to distinct parameters
# list_kMEs <- vector(mode="list", length=length(list_MEs))
#
# for (j in 1:length(list_MEs)) {
# list_kMEs[[j]] = signedKME(datExpr=as.matrix(datExpr),
# datME=list_MEs[[j]],
# #list_MEs[[j]],#$eigengenes,
# outputColumnName="",
# corFnc = corFnc )
# }
# }, error = function(cellCluster) warning(paste0("signedkME failed for ", cellCluster)))
# return(list_kMEs)
# }
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# replaceNA = function(replace_in, replace_from) {
# replace_in[is.na(replace_in)] <- replace_from[is.na(replace_in)]
# return(replace_in)
# }
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# parPkMs = function(list_kMs,
# list_colors) {
#
# #if (!all(sapply(list_kMs, function(x) any("grey" %in% colnames(x)) ))) stop("'grey' module kMEs not found")
#
# list_pkMs <- list()
# #if(!is.null(list_kMs)) list_kMs <- lapply(list_kMs, function(x) name_for_vec(to_be_named = x, given_names = gsub("kME", "", colnames(x), ignore.case =F), dimension=2))
#
# for (j in 1:length(list_colors)) {
# pkMs <- NULL
# # Get the 'principal kMEs', i.e. kME of each gene to the module to which it is allocated
# if (!is.null(list_kMs[[j]]) & length(unique(list_colors[[j]]))>1) {
# pkMs <- vector(mode="numeric",length=length(list_colors[[j]]))
# ###
# # Loop over every gene and get its pkME
# for (i in 1:length(pkMs)) {
# #pkMEs[i] <- list_kMEs[[j]][diffParams_colors[i,j]][i,]
# pkMs[i] <- if (list_colors[[j]][i]=="grey") 0 else list_kMs[[j]] [list_colors[[j]][i]] [i,]
# }
#
# list_pkMs[[j]] <- pkMs
# names(list_pkMs[[j]]) <- names(list_colors[[j]])
#
# } else {
# list_pkMs[[j]] = rep(0, length(list_colors[[j]]))
# names(list_pkMs[[j]]) <- names(list_colors[[j]])
# }
# }
# return(list_pkMs)
# }
# parPkMs_2 = function(list_kMs, list_colors) {
#
# list_pkMs <- list()
#
# for (j in 1:length(list_colors)) {
# # Get the 'principal kMEs', i.e. kME of each gene to the module to which it is allocated
# # EDIT_180421_8
# #pkMEs <- vector(mode="numeric",length=nrow(diffParams_colors))
#
# pkMs <- vector(mode="numeric",length=length(list_colors[[1]]))
# ###
# # Loop over every gene and get its pkME
# for (i in 1:length(pkMs)) {
# #pkMEs[i] <- list_kMEs[[j]][diffParams_colors[i,j]][i,]
# pkMs[i] <- list_kMs[[j]][list_colors[[j]][[i]]] [i,]
# }
#
# list_pkMs[[j]] <- pkMs
#
# }
# return(list_pkMs)
# }
pkMs_fnc = function(kMs, colors) {
pkMs <- NULL
if (!is.null(kMs) & length(unique(colors))>1) {
for (i in 1:length(colors)) {
pkMs[i] <- if (colors[i]=="grey") 0 else kMs[colors[i]] [i,]
}
names(pkMs) <- names(colors)
} else {
pkMs = rep(0, length(colors))
names(pkMs) <- names(colors)
}
return(pkMs)
}
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# deleteGrey <- function(list_kMs) {
# for (k in 1:length(list_kMs)) {
# if (any(colnames(list_kMs[[k]]) == "grey")) list_kMs[[k]][['grey']] <- NULL
# if (any(colnames(list_kMs[[k]]) == "kMEgrey")) list_kMs[[k]][['kMEgrey']] <- NULL
# }
# return(list_kMs)
# }
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
fnc_kMReassign = function(modcolors,
fuzzyModMembership,
dissTOM = NULL,
datExpr = NULL,
verbose=2,
corFnc=NULL,
max_iter=3,
reassign_threshold=1.2,
cellType) {
# Usage: iteratively reassign genes to modules based on kIM / kME until the number to reassign <= stop_condition
# Args:
# fuzzyModMembership: "kME" or "kIM"
# dissTOM: list of TOM distance matrices. Only required if fuzzyModMembership = "kIM"
# datExpr: cell x gene expression matrix. Only required if fuzzyModMembership = "kME"
# modcolors: vector of module assignments with gene names
# corFnc: WGCNA correlation function; only needed if fuzzyModMembership = "kME"
# verbose: 0-5, controls message output
# max_iter: integer; max iterations.
# reassign_threshold: threshold ratio of competing to current module kME for reassignment to occur
# Value:
# list with entries "modcolors", "kMs" and "log".
print(paste0(cellType, ": Reassigning genes to modules with higher ", fuzzyModMembership))
# initialise
tryCatch({
modcolors_original <- modcolors_new <- modcolors
reassign_total <- reassign_t_1 <- logical(length(modcolors))
reassign_t <- ! logical(length(modcolors))
min_change = 5 # the minimum change from one iteration to the next required to continue
t = 1
MEs <- NULL
kMs <- NULL
log=NULL
if (!is.null(modcolors) & length(unique(modcolors))>1) {
while(TRUE) {
if (fuzzyModMembership == "kME") {
message(paste0(cellType, ": Computing Module Eigengenes"))
MEs <- moduleEigengenes_uv(expr=datExpr, # TODO do we need to make it into a dataframe with names?..
colors = modcolors,
excludeGrey=T)$eigengenes
message(paste0(cellType, ": Computing ", fuzzyModMembership, "s"))
kMs <- signedKME(as.matrix(datExpr),
MEs,
outputColumnName = "",
corFnc = corFnc)
} else if (fuzzyModMembership == "kIM") {
kMs <- kIM_eachMod_norm(dissTOM=dissTOM,
colors=modcolors,
verbose=verbose,
excludeGrey=T)
}
message(paste0(cellType, ": Computing primary "), fuzzyModMembership, "s")
pkMs <- pkMs_fnc(kMs=kMs, colors=modcolors)
maxkMs <- max.col(kMs, ties.method = "random") # integer vector of length nrow(kMs)
# Reassign if there is a kM value to another module which is more than reassign_threshold times the current pkM value
modcolors_new <- mapply(function(i, j, pkM) if (kMs[i,j] > reassign_threshold*pkM) colnames(kMs)[j] else modcolors[i], i = 1:length(maxkMs), j = maxkMs, pkM=pkMs, SIMPLIFY=T) # get new module assignment vector
modcolors_new[modcolors=="grey"] <- "grey" # Do not reallocate genes previously allocated to grey, since they are likely to get reallocated as "grey" is not a real cohesive module
names(modcolors_new) <- names(modcolors)
reassign_t <- modcolors_new != modcolors
if ((t>1 & sum(reassign_t_1) - sum(reassign_t) < min_change) | sum(reassign_t) < min_change | t >= max_iter) break #else message(paste0(cellType, ", iteration ", t, ": reassigning ", sum(reassign_t), " genes to new modules based on their ", fuzzyModMembership))
modcolors <- modcolors_new
reassign_total <- reassign_total | reassign_t
reassign_t_1 <- reassign_t
t = t+1
}
log <- data.frame("gene" = names(modcolors)[reassign_total],
"original_module" = modcolors_original[reassign_total],
"new_module" = modcolors_new[reassign_total], stringsAsFactors=F, row.names=NULL)
if (verbose > 0) print(paste0(cellType, ": a total of ", sum(reassign_total), " genes reassigned to new modules"))
} else {
warning(paste0(cellType, ": one or no modules, nothing to reassign"))
}
return(list("colors" = modcolors_new, "kMs" = kMs, "log" = log))
},
error = function(c) {
warning(paste0("fnc_kMReassign failed for ", cellType, " with the following error: ", c))
return(list("colors" = modcolors_original,
"kMs" = NULL,
"log" = NULL))}
)
}
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# DEPRECATED
# kM_reassign_neg_fnc = function(Ms,
# kMs,
# pkMs,
# kM_reassign_threshold,
# colors,
# datExpr,
# corFnc,
# excludeGrey) {
# # Status: hiatus - currently unused
# # Returns a list with new colors,l MEs, kMEs, pkMEs, and dataframe with information on the reassigned genes
#
# results <- list()
# old_colors = colors
# reassigned = NULL
#
# col_most_negkME = max.col(-1*kMEs) # indices of most negative kMEs
#
# rows_to_reassign <- logical(length=length(colors))
#
# for (i in nrow(kMEs)) {
# rows_to_reassign[i] <- kMEs[i, col_most_negkME[i]] < -kME_reassign_threshold*(pkMEs[i])
# }
#
# if (sum(rows_to_reassign) > 0) {
#
# reassigned = colors[rows_to_reassign]
# colors[rows_to_reassign] <- colors[col_most_negkME][rows_to_reassign]
#
# # Recompute Module Eigengenes, kME, pkME
# MEs = moduleEigengenes_uv(expr = as.matrix(datExpr),
# colors= colors,
# excludeGrey = excludeGrey)$eigengenes
#
# kMEs = signedKME(as.matrix(datExpr),
# MEs,
# outputColumnName = "",
# corFnc = corFnc)
#
# pkMEs <- vector(length=length(colors))
#
#
# for (i in 1:length(colors)) {
# pkMEs[i] <- as.numeric(unlist(kMEs %>% dplyr::select(matches(colors[[i]]))))[[i]]
# }
#
# #reassigned = data.frame(gene=names(colors[rows_to_reassign]), old_module = old_colors, new_module = colors[rows_to_reassign], old_pkME = old_pkMEs, new_pkME = pkMEs[rows_to_reassign], row.names = NULL)
# }
#
# results$colors <- colors
# results$old_colors <- old_colors
# results$MEs <- MEs
# results$kMEs <- kMEs
# results$pkMEs <- pkMEs
# results$reassigned <- names(colors[rows_to_reassign])
#
# return(results)
# }
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
kIM_eachMod_norm = function(dissTOM, colors, verbose=2, excludeGrey=T, do.par=F, n_cores=3) {
# compute intramodularConnectivity for every gene with regard to every module
# Args:
# dissTOM: distance matrix from WGCNA in sparse matrix form
# colors: vector of module assignment 'color' labels with gene names
# verbose: controls messages
# excludeGrey: compute "grey" kME?
# Value:
# kIMs: gene x module dataframe of normalised intramodular gene-module connectivity scores,
# which are just the mean distance between the gene and every gene in that module
unique_colors = sort(names(table(colors)))#[-which(sort(names(table(colors))) == "grey")]
if (excludeGrey ==T) unique_colors <- unique_colors[!unique_colors=="grey"]
# Convert the distance matrix to a proximity matrix. Nb: It is square with 0 diagonal
mTOM <- as.matrix(1-dissTOM)
rm(dissTOM)
colnames(mTOM) <- rownames(mTOM) <- names(colors)
# make a gene * unique_colors matrix for results: each gene's degree w.r.t each color (module)
results = matrix(nrow=nrow(mTOM), ncol=length(unique_colors))
for (j in 1:length(unique_colors)) { # modules in columns
idx_mTOM_col <- match(names(colors)[colors %in% unique_colors[[j]]], colnames(mTOM))
idx_mTOM_col <- idx_mTOM_col[!is.na(idx_mTOM_col)]
norm_term <- max(1,length(idx_mTOM_col)-1)
#norm_term <- (sum(colors == unique_colors[[j]])-1)
mTOM_mod_sub <- mTOM[, idx_mTOM_col, drop=F]
cl <- NULL
if (do.par) {
invisible(gc()); invisible(R.utils::gcDLLs())
cl <- try(makeCluster(spec=n_cores, type="FORK", timeout=30))
if (!"try-error" %in% class(cl)) {
if (verbose>2) message(paste0("Computing kIM for ", unique_colors[j], " using ", n_cores, " cores"))
results[,j] <- parSapply(cl=cl, X = 1:nrow(mTOM_mod_sub), FUN=function(i) {
sum(mTOM_mod_sub[i, ]) / norm_term
})
stopCluster(cl)
}
}
if ("try-error" %in% class(cl) | !do.par) {
do.par <- F
if (verbose>2) message(paste0("Computing kIM for ", unique_colors[j], " serially"))
results[,j] <- sapply( X = 1:nrow(mTOM_mod_sub), FUN=function(i) {
sum(mTOM_mod_sub[i, ]) / norm_term
})
}
rm(mTOM_mod_sub)
invisible(gc()); invisible(R.utils::gcDLLs())
if (verbose>2) message(paste0("Done computing kIM for ", unique_colors[j]))
}
if (verbose>0) message("Done computing kIMs for set of colors")
# Output a dataframe with genes in rows and modules (colors) as columns
results <- as.data.frame(results, row.names= rownames(mTOM))
colnames(results) = unique_colors
return(results)
}
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# pkIM_norm_var <- function(dissTOM,
# colors,
# cellType,
# verbose=2,
# excludeGrey=T) {
#
# if (verbose>0) message(paste0(cellType, ": computing pkIM variances"))
# # compute variance of intramodularConnectivity for every gene with regard to its own
# # Args:
# # dissTOM: distance matrix from WGCNA in sparse matrix form
# # colors: vector of module assignment 'color' labels with gene names
# # verbose: controls messages
# # excludeGrey: compute "grey" kME?
# # Value:
# # kIMs: gene x module dataframe of normalised intramodular gene-module connectivity scores,
# # which are just the mean distance between the gene and every gene in that module
#
# # Convert the distance matrix to a proximity matrix. Nb: It is square with 0 diagonal
# mTOM <- as.matrix(1-dissTOM)
# # make a gene * unique_colors matrix for results: each gene's degree w.r.t each color (module)
# results <- mapply(function(gene,color) var(mTOM[names(colors)==gene, colors == color & names(colors) != gene] / (sum(colors == color)-1)), gene=names(colors), color=colors, SIMPLIFY=T)
# if (verbose>0) message(paste0(cellType, ": Done computing pkIM variances"))
# return(results)
# }
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# kEM_norm = function(dissTOM, colors, cellType, verbose=2, excludeGrey=T) {
# # compute normalised extramodularConnectivity for every gene with regard to all genes outside its module (a single number)
# # Args:
# # dissTOM: distance matrix from WGCNA in sparse matrix form
# # colors: vector of module assignment 'color' labels with gene names
# # verbose: controls messages
# # excludeGrey: compute "grey" kME?
# # Value:
# # kEMs: gene-named vector of normalised extramodular connectivity scores,
# # i.e. the average link between each gene and all genes outside its module
#
# # Convert the distance matrix to a proximity matrix. Nb: It is square with 0 diagonal
# message(paste0(cellType, ": Computing kEMs"))
# mTOM <- as.matrix(1-dissTOM)
# results <- mapply(function(gene,color) sum(mTOM[names(colors)==gene, colors != color]) / sum(colors != color), gene=names(colors), color=colors, SIMPLIFY=T)
# if (verbose>0) message(paste0(cellType, ": Done computing kEMs"))
# names(results) <- names(colors)
# return(results)
# }
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# kEM_norm_var = function(dissTOM, colors, cellType) {
# # compute variance of extramodular Connectivity for each gene
# message(paste0(cellType, ": Computing kEM variances"))
# mTOM <- as.matrix(1-dissTOM)
# tryCatch({
# results = mapply(function(color, gene) stats::var(x=(mTOM[names(colors)==gene, !colors==color])/sum(colors!=color), na.rm=T),
# color=colors,
# gene=names(colors),
# SIMPLIFY=T) # for gene i, compute variance of connections to other modules
# names(results) = names(colors)
# }, error = function(c) {
# results = vector(mode="numeric", length=length(colors))
# warning(paste0(cellType, ": kEM variance calculation failed"))
# })
# if (verbose>0) message(paste0(cellType, ": Done computing kEM variances"))
# return(results)
# }
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# count_grey_in_list_of_vec = function(list_colors) {
# vec_n_grey <- sapply(list_colors, function(x) sum(x=="grey"), simplify=T)
# return(vec_n_grey)
# }
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# getPkMs <- function(colors, kMs) {
# pkMs <- vector(length=length(colors))
#
# for (i in 1:length(colors)) {
# pkMs[i] <- kMs[colors[i]][i,]
# }
#
# return(pkMs)
# }
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# plottable_colors <- function(colors) {
# # takes a vector of colors, i.e. module assignments
# # if all are recognised R colors then it returns the vector as is
# # otherwise, first try to remove full stops and numbers. Then try to replace them and returns the vector
#
# idx_not_real_colors = !(colors %in% colors())
#
# if (sum(idx_not_real_colors)>0) {
# colors[idx_not_real_colors] <- gsub("\\.\\d+|\\_\\d+", "", colors[idx_not_real_colors])
# }
#
# # If there are still any 'not real' colors, make them black
# idx_not_real_colors = !(colors %in% colors())
# n_replace <- sum(idx_not_real_colors)
#
# if (n_replace>0) {
# #unused = setdiff(colors(), colors)
# colors[idx_not_real_colors] <- "black" #unused[1:n_replace]
# }
#
# return(colors)
# }
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# checkGrey <- function(kMs) {
# if (any(grepl("grey", colnames(kMs)))) kMs[['grey']] <- NULL
# return(kMs)
# }
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# plotDendro_for_vec <- function(list_colors,
# geneTree,
# list_labels,
# subsetName,
# title,
# flag_file) {
#
# list_colors <- lapply(list_colors, plottable_colors)
#
# colors_mat = matrix(unlist(list_colors), nrow=length(list_colors[[1]]), ncol=length(list_colors))
#
# pdf(sprintf("%s%s_%s_%s_diffParams_colors_order_%s.pdf", plots_dir, prefixData, subsetName, flag_file, flag_date), width = 9, height = 5+length(list_colors) %/% 2)
# plotDendroAndColors(geneTree,
# #labels2colors(list_colors_PPI_order),
# #matrix(unlist(list_colors_PPI_order), ncol = length(list_colors_PPI_order), byrow = F),
# colors_mat,
# groupLabels = list_labels,
# addGuide= TRUE,
# dendroLabels=FALSE,
# main=paste0(title, " - ", subsetName),
# cex.colorLabels=0.4)
#
# dev.off()
# }
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# plotCorr_for_par = function(corrMatrix, vectorNames, subsetName, diag, is.corr, order, hclust.method) {
# pdf(sprintf("%s%s_%s_%s_corr_%s.pdf", plots_dir, prefixData, subsetName, vectorNames, flag_date))#,width=nrow(corrMatrix) %/% 4, height=(nrow(corrMatrix) %/% 4)+1)
# corrplot(corr = corrMatrix,
# method = "color",
# add=F,
# #col = colorRampPalette(rev(brewer.pal(n = 7, name = "RdYlBu")))(100),
# title=sprintf("%s %s correlations", subsetName, vectorNames),
# is.corr = is.corr,
# diag=diag,
# #mar = c(0, 0, 0, 0),
# #addCoef.col = T, # this adds an annoying number label to each square
# order = order,
# hclust.method = hclust.method,
# number.digits = NULL)
# #clustering_distance_rows = dist(resR.G_G@listData$pvalue[select], method="euclidian"))
# dev.off()
# }
############################################################################################################################################################
############################################################################################################################################################
############################################################################################################################################################
# wrapModulePreservation <- function(listDatExpr,
# listColors,
# labels = if (is.null(names(listColors))) 1:length(listColors) else names(listColors),
# dataIsExpr,
# networkType,
# corFnc,
# corOptions,
# # We actually just want to get quality stats on the reference network,
# # but the function requires testNetworks..
# nPermutations,
# includekMEallInSummary,
# restrictSummaryForGeneralNetworks,
# calculateQvalue,
# randomSeed,
# maxGoldModuleSize,
# maxModuleSize,
# quickCor,
# ccTupletSize,
# #calculateCor.kIMall,
# calculateClusterCoeff,
# useInterpolation,
# checkData,
# #greyName,
# savePermutedStatistics ,
# loadPermutedStatistics,
# permutedStatisticsFile,
# plotInterpolation,
# interpolationPlotFile,
# discardInvalidOutput,
# parallelCalculation,
# nThreads,
# verbose,
# indent) {
#
# # STATUS: 181026: Fixed a bug in WGCNA::modulePreservation (https://www.biostars.org/p/339950/) (actually arises when calling signedKME)
# # @Usage: Wrapper for the WGCNA modulePreservation function to make it easier to use for single and multiple datasets.
# # The wrapper puts datasets and module assignment (colors) into the correct multiData and multiColor formats.
# #
# # WGCNA::modulePreservation notes
# # * This function calculates module preservation statistics pair-wise between given reference sets and all other sets in multiExpr.
# # * Reference sets must have their corresponding module assignment specified in multiColor; module assignment is optional for test sets.
# # * Individual expression sets and their module labels are matched using names of the corresponding components in multiExpr and multiColor.
# # *
# # *
# #
# # WGCNA::modulePreservation performs two distinct tasks:
# #
# # 1. evaluates the quality of one or more sets of module assignments in a single dataset
# # 2. evaluates the preservation of a single set of colors in multiple datasets
# #
# # Multiple colors in multiple datasets is not supported.
# #
# # In each case, modulePreservation function requires 'reference' and 'test datasets regardless.