mcml: mcml - Deprecated alias for cluster_summary

View source: R/plot-mcml.R

mcmlR Documentation

mcml - Deprecated alias for cluster_summary

Description

[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

## Not run: 
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)

## End(Not run)

cograph documentation built on April 1, 2026, 1:07 a.m.