Skip to contents

mcml - Deprecated alias for cluster_summary

Source: R/plot-mcml.R
mcml.Rd

[Deprecated]

Use cluster_summary instead. This function is provided for backward compatibility only.

Usage

mcml(
  x,
  cluster_list = NULL,
  aggregation = c("sum", "mean", "max"),
  as_tna = FALSE,
  nodes = NULL,
  within = TRUE
)

Arguments

x

Weight matrix, tna object, cograph_network, or cluster_summary object

cluster_list

Named list of node vectors per cluster

aggregation

How to aggregate edge weights: "sum", "mean", "max"

as_tna

Logical. If TRUE, return a tna-compatible object

nodes

Node metadata

within

Logical. Compute within-cluster matrices

Value

A cluster_summary object (or tna if as_tna = TRUE)

Examples

set.seed(1)
mat <- matrix(runif(100, 0, 0.3), 10, 10); diag(mat) <- 0
colnames(mat) <- rownames(mat) <- paste0("N", 1:10)
clusters <- list(C1 = paste0("N", 1:5), C2 = paste0("N", 6:10))
mcml(mat, clusters)
#> Cluster Summary
#> ---------------
#> Type: tna 
#> Method: sum 
#> Clusters: 2 
#> Nodes: 10 
#> Cluster sizes: 5, 5 
#> 
#> Macro (cluster-level) weights (2x2):
#>   Inits: 0.515, 0.485 
#>       C1    C2
#> C1 0.469 0.531
#> C2 0.559 0.441
#> 
#> Per-cluster weights:
#>   C1 (5 nodes)
#>   C2 (5 nodes)