PackageReport: Package Report

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

Package Report

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.

Class Constructor

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

• Initialize an instance of a package report object.

• Args:

  • pkg_name (character string) name of package

  • pkg_path: (character string) optional directory path to source code of the package. It is used for calculating test coverage. It can be an absolute or relative path.

  • report_path: (character string) The path and filename of the output report. Default report will be produced in the temporary directory.

• Returns:

  • Instantiated package report object.

Public Methods

add_reporter(reporter)

• Add a reporter to the package report.

• Args:

  reporter: Instantiated package reporter object

• Returns:

  • Self, invisibly.

render_report()

• Render html pkgnet package report.

• Returns:

  • Self, invisibly.

Public Fields

pkg_name

(character string) name of package. Read-only.

pkg_path

(character string) path to source code of the package. Read-only.

report_path

(character string) path and filename of output report.

SummaryReporter

instantiated pkgnet SummaryReporter object

DependencyReporter

instantiated pkgnet DependencyReporter object

FunctionReporter

instantiated pkgnet FunctionReporter object

InheritanceReporter

instantiated pkgnet InheritanceReporter object

Special Methods

clone(deep = FALSE)

• Method for copying an object. See Advanced R for the intricacies of R6 reference semantics.

• Args:

  • deep(logical) Whether to recursively clone nested R6 objects.

• Returns:

  • Cloned object of this class.

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