Package 'pkgnet'

Description

Create a standalone HTML report about a package and its networks.

Usage

CreatePackageReport(
  pkg_name,
  pkg_reporters = DefaultReporters(),
  pkg_path = NULL,
  report_path = tempfile(pattern = pkg_name, fileext = ".html")
)

Arguments

Value

an instantiated PackageReport object

Description

Create pkgnet package report as an R Markdown vignette. This vignette can be rendered into a standard HTML vignette with the knitr::rmarkdown vignette engine into HTML vignettes upon package building. It is also compatible with #' pkgdown sites. See the vignette "Publishing Your pkgnet Package Report" for details about how to use this function, as well as our example for pkgnet.

Usage

CreatePackageVignette(
  pkg = ".",
  pkg_reporters = list(DependencyReporter$new(), FunctionReporter$new()),
  vignette_path = file.path(pkg, "vignettes", "pkgnet-report.Rmd")
)

Arguments

Description

Instantiates a list of default reporters to feed into CreatePackageReport.

Usage

DefaultReporters()

Details

Default reporters are:

• SummaryReporter

• DependencyReporter

• FunctionReporter

Note, InheritanceReporter is not included in the default list.

If desired, append a new instance of InheritanceReporter to the DefaultReporters list.

ex: c(DefaultReporters(), InheritanceReporter$new())

Value

list of instantiated reporter objects

Description

This reporter looks at the recursive network of its dependencies on other packages. This allows a developer to understand how individual dependencies might lead to a much larger set of dependencies, potentially informing decisions on including or removing them.

Super classes

pkgnet::AbstractPackageReporter -> pkgnet::AbstractGraphReporter -> DependencyReporter

Active bindings

Methods

Public methods

• DependencyReporter$new()

• DependencyReporter$clone()

Method new()

Initialize an instance of the reporter.

Usage

DependencyReporter$new(
  dep_types = c("Imports", "Depends", "LinkingTo"),
  installed = TRUE
)

Arguments

Returns

Self, invisibly.

Examples

\donttest{

# Instantiate an object
reporter <- DependencyReporter$new()

# Seed it with a package
reporter$set_package("ggplot2")

}

Method clone()

The objects of this class are cloneable with this method.

Usage

DependencyReporter$clone(deep = FALSE)

Arguments

See Also

Other Network Reporters: FunctionReporter, InheritanceReporter

Other Package Reporters: FunctionReporter, InheritanceReporter, SummaryReporter

Examples

## ------------------------------------------------
## Method `DependencyReporter$new`
## ------------------------------------------------



# Instantiate an object
reporter <- DependencyReporter$new()

# Seed it with a package
reporter$set_package("ggplot2")

Description

R6 class defining a directed graph model for representing a network, including methods to calculate various measures from graph theory. The igraph package is used as a backend for calculations.

This class isn't intended to be initialized directly; instead, network reporter objects will initialize it as its pkg_graph field. If you have a network reporter named reporter, then you access this object's public interface through pkg_graph—for example,

reporter$pkg_graph$node_measures('hubScore')

Super class

pkgnet::AbstractGraph -> DirectedGraph

Active bindings

Methods

Public methods

• DirectedGraph$clone()

Method clone()

The objects of this class are cloneable with this method.

Usage

DirectedGraph$clone(deep = FALSE)

Arguments

See Also

DirectedGraphMeasures

Description

This reporter looks at the network of interdependencies of its defined functions. Measures of centrality from graph theory can indicate which function is most important to a package. Combined with unit test coverage information—also provided by this reporter— it can be used as a powerful tool to prioritize test writing.

Details

R6 Method Support:

R6 classes are supported, with their methods treated as functions by the reporter.

• R6 methods will be named like <classname>$<methodtype>$<methodname>, e.g., FunctionReporter$private_methods$extract_nodes.

• Note that the class name used will be the name of the generator object in the package's namespace.

• The classname attribute of the class is not used. In general, it is not required to be defined or the same as the generator object name. This attribute is used primarily for S3 dispatch.

Known Limitations:

• Using non-standard evaluation to refer to things (e.g, dataframe column names) that have the same name as a function will trick FunctionReporter into thinking the function was called. This can be avoided if you don't use reuse function names for other purposes.

• Functions stored as list items and not assigned to the package namespace will be invisible to FunctionReporter.

• Calls to methods of instantiated R6 or reference objects will not be recognized. We don't have a reliable way of identifying instantiated objects, or identifying their class.

• Reference class methods are not yet supported. They will not be identified as nodes by FunctionReporter.

Super classes

pkgnet::AbstractPackageReporter -> pkgnet::AbstractGraphReporter -> FunctionReporter

Active bindings

Methods

Public methods

• FunctionReporter$calculate_default_measures()

• FunctionReporter$clone()

Method calculate_default_measures()

Calculates the default node and network measures for this reporter.

Usage

FunctionReporter$calculate_default_measures()

Returns

Self, invisibly.

Method clone()

The objects of this class are cloneable with this method.

Usage

FunctionReporter$clone(deep = FALSE)

Arguments

See Also

Other Network Reporters: DependencyReporter, InheritanceReporter

Other Package Reporters: DependencyReporter, InheritanceReporter, SummaryReporter

Description

This reporter takes a package and traces the class inheritance structure. Currently the following object-oriented systems are supported:

• S4 Classes

• Reference Classes (sometimes informally called "R5")

• R6 Classes

S3 classes are not supported, as their inheritance is defined on an ad hoc basis per object and not formally by class definitions.

Details

Note the following details about class naming:

• Reference Classes : The name passed as Class in setRefClass is used as the node name by this reporter. This is the class name that is used when specifying inheritance. The generator object returned by setRefClass does not have to be assigned and can have a different name.

• R6 Classes : The name of the generator object in the package namespace is used as the node name by this reporter. The generator object returned by R6::R6Class is what is used when specifying inheritance. The name passed as classname passed to R6::R6Class can be a different name or even NULL.

For more info about R's built-in object-oriented systems, check out the relevant chapter in Hadley Wickham's Advanced R. For more info about R6, check out their docs website or the chapter in Advanced R's second edition.

Super classes

pkgnet::AbstractPackageReporter -> pkgnet::AbstractGraphReporter -> InheritanceReporter

Active bindings

Methods

Public methods

• InheritanceReporter$clone()

Method clone()

The objects of this class are cloneable with this method.

Usage

InheritanceReporter$clone(deep = FALSE)

Arguments

See Also

Other Network Reporters: DependencyReporter, FunctionReporter

Other Package Reporters: DependencyReporter, FunctionReporter, SummaryReporter

Description

pkgnet compiles one or more package reporters into a package report for a specified package. PackageReport is an R6 class that holds all of those reporters and has a method render_report() to generate an HTML report file. You can access each individual reporter and modify it using its methods if you wish.

The function CreatePackageReport() is a shortcut for both generating a PackageReport object with instantiated reporters and creating the HTML report in one call.

Value

Self, invisibly.

Active bindings

Methods

Public methods

• PackageReport$new()

• PackageReport$add_reporter()

• PackageReport$render_report()

• PackageReport$clone()

Method new()

Initialize an instance of a package report object.

Usage

PackageReport$new(
  pkg_name,
  pkg_path = NULL,
  report_path = tempfile(pattern = pkg_name, fileext = ".html")
)

Arguments

Returns

Instantiated package report object.

Method add_reporter()

Add a reporter to the package report.

Usage

PackageReport$add_reporter(reporter)

Arguments

Returns

Self, invisibly

Method render_report()

Render html pkgnet package report.

Usage

PackageReport$render_report()

Method clone()

The objects of this class are cloneable with this method.

Usage

PackageReport$clone(deep = FALSE)

Arguments

Description

This reporter provides a high-level overview of a package via its package DESCRIPTION file.

Super class

pkgnet::AbstractPackageReporter -> SummaryReporter

Active bindings

Methods

Public methods

• SummaryReporter$get_summary_view()

• SummaryReporter$clone()

Method get_summary_view()

Returns an htmlwidget object that summarizes the analysis of the reporter. Used when creating a package report.

Usage

SummaryReporter$get_summary_view()

Returns

Self, invisibly.

Method clone()

The objects of this class are cloneable with this method.

Usage

SummaryReporter$clone(deep = FALSE)

Arguments

See Also

Other Package Reporters: DependencyReporter, FunctionReporter, InheritanceReporter