R/CRITERION.R

In DynComm: Dynamic Network Communities Detection and Generation

########################### Developer Notice ###########################
# Description:
#
# This file holds the user friendly documentation of all available DynComm 
# criterion (CRITERION).
#
# Development documentation of new criterion (CRITERION) should be added beside 
# the algorithm implementation.
#
# This documentation should not have examples, export, usage, format or return
# tags since those are not applicable by an end user.
#
# More developer information can be found in the project source page on GitHub at
# https://github.com/softskillsgroup/DynComm-R-package
#
#
# Author: poltergeist0
# Date: 2019-01-01

#' @name CRITERION_MODULARITY
#' 
#' @title CRITERION_MODULARITY
#'
#' @author poltergeist0
#' 
#' @description 
#' Newman-Girvan criterion.
#' 
# @details 
#'
#' @rdname CRITERION_MODULARITY
#' 
#' @seealso \code{\link{DynComm}}
#' 
#' @section Supported in ALGORITHM:
#' \describe{
#'   \item{LOUVAIN}{See \code{\link{ALGORITHM_LOUVAIN}}}
#' }
#' 
#' @section PARAMETERS:
#' This criterion does not require any parameters.
#' 
NULL