NetworkReporters: Network Reporters for Packages

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

Network Reporters for Packages

Description

pkgnet defines several package reporter R6 classes that model a particular network aspect of a package as a graph. These network reporter classes are extended from AbstractGraphReporter, which itself extends the AbstractPackageReporter with graph-modeling-related functionality.

This article describes the additional fields added by the AbstractGraphReporter class definition.

Public Methods

calculate_default_measures()

• Calculates the default node and network measures for this reporter.

• Returns:

  • Self, invisibly.

Public Fields

nodes

a data.table, containing information about the nodes of the network the reporter is analyzing. The node column acts the identifier. Read-only.

edges

a data.table, containing information about the edge connections of the network the reporter is analyzing. Each row is one edge, and the columns SOURCE and TARGET specify the node identifiers. Read-only.

network_measures

a list, containing any measures of the network calculated by the reporter. Read-only.

pkg_graph

a graph model object. See DirectedGraph for additional documentation. Read-only.

graph_viz

a graph visualization object. A visNetwork::visNetwork object. Read-only.

layout_type

a character string, the current layout type for the graph visualization. Can be assigned a new valid layout type value. Use use grep("^layout_\\S", getNamespaceExports("igraph"), value = TRUE) to see valid options.

UptakeOpenSource/pkgnet documentation built on April 20, 2024, 3:14 p.m.