From 26d795db80ac08dbe81f6c0ef8f91c8b288295fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Tue, 23 Jan 2024 12:45:55 +0100 Subject: [PATCH] Update R/assortativity.R MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Szabolcs Horvát --- R/assortativity.R | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/R/assortativity.R b/R/assortativity.R index 3a4a731a3b..2c10636233 100644 --- a/R/assortativity.R +++ b/R/assortativity.R @@ -116,8 +116,10 @@ assortativity.degree <- function(graph, directed = TRUE) { # nocov start #' `TRUE` here to do the natural thing, i.e. use directed version of the #' measure for directed graphs and the undirected version for undirected #' graphs. -#' @param normalized Boolean, whether to compute the normalized covariance, -#' i.e. Pearson correlation. Supply true here to compute the standard assortativity. +#' @param normalized Boolean, whether to compute the normalized assortativity. +#' The non-normalized nominal assortativity is identical to modularity. +#' The non-normalized value-based assortativity is simply the covariance of the +#' values at the two ends of edges. #' @param types1,types2 #' `r lifecycle::badge("deprecated")` #' Deprecated aliases for `values` and `values.in`, respectively.