SimpleSBM_fit: R6 Class definition of a Simple SBM fit

Description Details Super classes Active bindings Methods

Description

R6 Class definition of a Simple SBM fit

R6 Class definition of a Simple SBM fit

Details

This class is designed to give a representation and adjust an SBM fitted with blockmodels.

The list of parameters estimOptions essentially tunes the optimization process and the variational EM algorithm, with the following parameters

Super classes

sbm::SBM -> sbm::SimpleSBM -> SimpleSBM_fit

Active bindings

loglik

double: approximation of the log-likelihood (variational lower bound) reached

ICL

double: value of the integrated classification log-likelihood

penalty

double, value of the penalty term in ICL

entropy

double, value of the entropy due to the clustering distribution

storedModels

data.frame of all models fitted (and stored) during the optimization

Methods

Public methods

Inherited methods

Method new()

constructor for a Simple SBM fit

Usage
SimpleSBM_fit$new(
  adjacencyMatrix,
  model,
  directed,
  dimLabels = c(node = "nodeName"),
  covarList = list()
)
Arguments
adjacencyMatrix

square (weighted) matrix

model

character ('bernoulli', 'poisson', 'gaussian')

directed

logical, directed network or not. In not, adjacencyMatrix must be symmetric.

dimLabels

list of labels of each dimension (in row, in columns)

covarList

and optional list of covariates, each of whom must have the same dimension as adjacencyMatrix


Method optimize()

function to perform optimization

Usage
SimpleSBM_fit$optimize(estimOptions = list())
Arguments
estimOptions

a list of parameters controlling the inference algorithm and model selection. See details.


Method setModel()

method to select a specific model among the ones fitted during the optimization. Fields of the current SBM_fit will be updated accordingly.

Usage
SimpleSBM_fit$setModel(index)
Arguments
index

integer, the index of the model to be selected (row number in storedModels)


Method reorder()

permute group labels by order of decreasing probability

Usage
SimpleSBM_fit$reorder()

Method show()

show method

Usage
SimpleSBM_fit$show(type = "Fit of a Simple Stochastic Block Model")
Arguments
type

character used to specify the type of SBM


Method clone()

The objects of this class are cloneable with this method.

Usage
SimpleSBM_fit$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


GrossSBM/sbm documentation built on April 8, 2021, 5:53 a.m.