% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rich-club.R
\name{rich_club_local}
\alias{rich_club_local}
\title{Local Rich Club Score}
\usage{
rich_club_local(
  x,
  prominence = NULL,
  rich = c("k", "s"),
  directed = NULL,
  digits = NULL,
  sort_by = "score",
  ...
)
}
\arguments{
\item{x}{Network input: matrix, igraph, network, cograph_network, or tna
object.}

\item{prominence}{Integer or logical vector indicating which nodes are
prominent (1/TRUE = prominent), OR a numeric threshold. If NULL, nodes
above median degree (or strength) are prominent.}

\item{rich}{Character. \code{"k"} (degree, default) or \code{"s"}
(strength). Used when \code{prominence} is NULL or a threshold.}

\item{directed}{Logical or NULL. Default NULL (auto-detect).}

\item{digits}{Integer or NULL. Round scores. Default NULL.}

\item{sort_by}{Character or NULL. Column to sort by (descending). Default
\code{"score"}.}

\item{...}{Additional arguments passed to \code{\link{to_igraph}}.}
}
\value{
A data frame with columns \code{node} and \code{score}, sorted
by \code{score} descending. Values > 1 indicate the node directs
disproportionately strong ties to prominent nodes.
}
\description{
For each node, measures whether it preferentially directs its strongest
ties toward prominent nodes. A score > 1 means the node's ties to
prominent nodes are stronger than average.
}
\details{
For each node i: \eqn{r_i = \bar{w}_{i \to rich} / \bar{w}_i}
}
\examples{
adj <- matrix(c(0,5,3,1, 5,0,4,2, 3,4,0,1, 1,2,1,0), 4, 4)
rownames(adj) <- colnames(adj) <- c("A", "B", "C", "D")
cograph::rich_club_local(adj, prominence = c(1, 1, 0, 0))
}
\references{
Opsahl, T., Colizza, V., Panzarasa, P. & Ramasco, J.J. (2008).
Prominence and control: The weighted rich-club effect. \emph{Physical
Review Letters}, 101, 168702.
}
\seealso{
\code{\link{rich_club}}, \code{\link{centrality}}
}
