DynComm: APIFUNCTIONS – R documentation

Pricing

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Get Started for Free

Documentation

DynComm

APIFUNCTIONS

List of API functions.

Description

This is a list of all functions of the API.

Usage

APIFUNCTIONS

Format

A named list with the names of all API functions:

COMMUNITIES: Get all communities after the last iteration. See communities
COMMUNITIESEDGECOUNT: Get the number of community to community edges in the graph. See communitiesEdgeCount
COMMUNITY: Get the community of the given vertex after the last iteration. See community
COMMUNITYCOUNT: Get the number of communities after the last iteration. See communityCount
COMMUNITYEDGEWEIGHT: Get the weight of the edge that goes from source to destination after the last iteration. See communityEdgeWeight
COMMUNITYINNEREDGESWEIGHT: Get the sum of weights of the inner edges of the given community after the last iteration. See communityInnerEdgesWeight
COMMUNITYMAPPINGMATRIX: Get a matrix with the community mapping for all communities after the last iteration.See communityMapping
COMMUNITYMAPPINGFILE: Write to a file the community mapping for all communities after the last iteration.See communityMapping
COMMUNITYNEIGHBOURS: Get the neighbours of the given community after the last iteration. See communityNeighbours
COMMUNITYTOTALWEIGHT: Get the sum of weights of all edges of the given community after the last iteration. See communityTotalWeight
COMMUNITYVERTEXCOUNT: Get the amount of vertices in the given community after the last iteration. See communityVertexCount
EDGECOUNT: Get the number of vertex to vertex edges in the graph. See edgeCount
EDGEWEIGHT: Get the weight of the edge that goes from source vertex to destination vertex after the last iteration. See edgeWeight
NEIGHBOURS: Get the neighbours of the given vertex after the last iteration. See neighbours
QUALITY: Get the quality measurement of the graph after the last iteration. See quality
RESULTS: Get additional results of the algorithm or the currently selected post processing steps. See results
VERTEXCOUNT: Get the total number of vertices after the last iteration. See vertexCount
VERTICESALL: Get all vertices in the graph after the last iteration. See verticesAll
VERTICES: Get all vertices belonging to the given community after the last iteration. See vertices

Details

Post processing algorithms must register, which functions of the API they implement, in a has() function. If the post processing algorithm implements a certain API function, the has() function must return TRUE when questioned about that API function. Otherwise, it must return FALSE.

Author(s)

poltergeist0