SummaryReporter: Package Summary Reporter

In pkgnet: Get Network Representation of an R Package

Package Summary Reporter

Description

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

Super class

pkgnet::AbstractPackageReporter -> SummaryReporter

Active bindings

report_markdown_path

(character string) path to R Markdown template for this reporter. Read-only.

Methods

Public methods

• SummaryReporter$get_summary_view()

• SummaryReporter$clone()

Inherited methods

• pkgnet::AbstractPackageReporter$set_package()

---

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

deep

Whether to make a deep clone.

See Also

Other Package Reporters: DependencyReporter, FunctionReporter, InheritanceReporter

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