% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/community.R
\name{optimal.community}
\alias{optimal.community}
\title{Optimal community structure}
\usage{
optimal.community(graph, weights = NULL)
}
\arguments{
\item{graph}{The input graph. It may be undirected or directed.}

\item{weights}{The weights of the edges. It must be a positive numeric
vector, \code{NULL} or \code{NA}. If it is \code{NULL} and the input graph has a
\sQuote{weight} edge attribute, then that attribute will be used. If
\code{NULL} and no such attribute is present, then the edges will have equal
weights. Set this to \code{NA} if the graph was a \sQuote{weight} edge
attribute, but you don't want to use it for community detection. A larger
edge weight means a stronger connection for this function.}
}
\description{
\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}}

\code{optimal.community()} was renamed to \code{cluster_optimal()} to create a more
consistent API.
}
\keyword{internal}