AbstractGraphReporter: Abstract Network Reporter Class

In pkgnet: Get Network Representation of an R Package

Abstract Network Reporter Class

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.

Super class

pkgnet::AbstractPackageReporter -> AbstractGraphReporter

Active bindings

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.

Methods

Public methods

• AbstractGraphReporter$calculate_default_measures()

• AbstractGraphReporter$get_summary_view()

• AbstractGraphReporter$clone()

Inherited methods

• pkgnet::AbstractPackageReporter$set_package()

---

Method calculate_default_measures()

Calculates the default node and network measures for this reporter.

Usage

AbstractGraphReporter$calculate_default_measures()

Returns

Self, invisibly.

---

Method get_summary_view()

Creates a summary table formatted for display.

Usage

AbstractGraphReporter$get_summary_view()

Returns

A DT object

---

Method clone()

The objects of this class are cloneable with this method.

Usage

AbstractGraphReporter$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

pkgnet documentation built on June 22, 2024, 12:19 p.m.