AbstractGraph: Base class for Graphs

In UptakeOpenSource/pkgnet: Get Network Representation of an R Package

Base class for Graphs

Description

pkgnet uses R6 classes to define and encapsulate the graph models for representing package networks. These classes implement different types of graphs and functionality to calculate their respective graph theory measures. The base class AbstractGraph defines the standard interfaces and functionality.

Currently the only implemented type of graph is DirectedGraph.

Active bindings

nodes

node data.table, read-only.

edges

edge data.table, read-only.

igraph

igraph object, read-only.

available_node_measures

character vector of all supported node measures. See Node Measures section in DirectedGraphMeasures for details about each measure.

available_graph_measures

character vector of all supported graph measures. See Graph Measures section in DirectedGraphMeasures for details about each measure. Read-only.

default_node_measures

character vector of default node measures. See Node Measures section in DirectedGraphMeasures for details about each measure.

default_graph_measures

character vector of default graph measures. See Graph Measures section in DirectedGraphMeasures for details about each measure. Read-only.

Methods

Public methods

• AbstractGraph$new()

• AbstractGraph$node_measures()

• AbstractGraph$graph_measures()

• AbstractGraph$print()

• AbstractGraph$clone()

---

Method new()

Instantiate new object of the class.

Usage

AbstractGraph$new(nodes, edges)

Arguments

nodes

a data.table containing nodes

edges

a data.table containing edges

Returns

Self, invisibly.

---

Method node_measures()

Return specified node-level measures, calculating if necessary. See Node Measures section in DirectedGraphMeasures for details about each measure.

Usage

AbstractGraph$node_measures(measures = NULL)

Arguments

measures

character vector of measure names. Default NULL will return those that are already calculated.

Returns

a data.table with specified node meaures as columns

---

Method graph_measures()

Return specified graph-level measures, calculating if necessary. See Graph Measures section in DirectedGraphMeasures for details about each measure.

Usage

AbstractGraph$graph_measures(measures = NULL)

Arguments

measures

character vector of measure names. Default NULL will return those that are already calculated.

Returns

list with specified graph measures.

---

Method print()

print igraph object

Usage

AbstractGraph$print()

Returns

Self, invisibly.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

AbstractGraph$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

UptakeOpenSource/pkgnet documentation built on May 20, 2024, 5:23 p.m.