SummaryReporter

<p>This reporter provides a high-level overview of a package via its package DESCRIPTION file.</p>

Tools from the domain of graph theory can be used to quantify the complexity
and vulnerability to failure of a software package. That is the guiding philosophy
of this package. 'pkgnet' provides tools to analyze the dependencies between functions
in an R package and between its imported packages.  See the pkgnet website for vignettes
and other supplementary information.

Brian Burns

pkgnet

Get Network Representation of an R Package

James Lamb

Jay Qi

SummaryReporter function

<p><code>pkgnet::AbstractPackageReporter</code> -&gt; <code>SummaryReporter</code></p>

Super class

<p><div class="r6-active-bindings"></div></p><dl>
<dt><code>report_markdown_path</code></dt>
<dd><p>(character string) path to R Markdown template for this reporter. Read-only.</p></dd><p></p><p>
</p></dl><p></p>

Active bindings


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/SummaryReporter%24get_summary_view()?package=pkgnet&version=0.6.0" data-mini-rdoc="pkgnet::SummaryReporter$get_summary_view()"><code>SummaryReporter$get_summary_view()</code></a></p></li>
<li><p><a href="/link/SummaryReporter%24clone()?package=pkgnet&version=0.6.0" data-mini-rdoc="pkgnet::SummaryReporter$clone()"><code>SummaryReporter$clone()</code></a></p></li>
</ul></p><p></p></div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="pkgnet" data-topic="AbstractPackageReporter" data-id="set_package"><a href="/link/pkgnet%3A%3AAbstractPackageReporter%24set_package()?package=pkgnet&version=0.6.0" data-mini-rdoc="pkgnet::pkgnet::AbstractPackageReporter$set_package()"><code>pkgnet::AbstractPackageReporter$set_package()</code></a></span></li>
</ul>
</details></p><p><hr>
<a id="method-SummaryReporter-get_summary_view"></a></p><div class="section" id="method-get-summary-view-">
<h3>Method <code>get_summary_view()</code></h3>
<p>Returns an htmlwidget object that summarizes the analysis of the reporter. 
Used when creating a package report.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>SummaryReporter$get_summary_view()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>Self, invisibly.</p>
</div></p><p></p><p><hr>
<a id="method-SummaryReporter-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>SummaryReporter$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

Package Summary Reporter — SummaryReporter

<p><div class="r6-active-bindings"></p><dl>
<dt><code>report_markdown_path</code></dt>
<dd><p>(character string) path to R Markdown template for this reporter. Read-only.</p></dd>


</dl><p></div></p>


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-SummaryReporter-get_summary_view'><code>SummaryReporter$get_summary_view()</code></a></p></li>
<li><p><a href='#method-SummaryReporter-clone'><code>SummaryReporter$clone()</code></a></p></li>
</ul>

</div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="pkgnet" data-topic="AbstractPackageReporter" data-id="set_package"><a href='../../pkgnet/html/AbstractPackageReporter.html#method-AbstractPackageReporter-set_package'><code>pkgnet::AbstractPackageReporter$set_package()</code></a></span></li>
</ul>
</details>

<hr>
<a id="method-SummaryReporter-get_summary_view"></a></p><div class='section' id='method-get-summary-view-'>
<h3>Method <code>get_summary_view()</code></h3>
<p>Returns an htmlwidget object that summarizes the analysis of the reporter. 
Used when creating a package report.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>SummaryReporter$get_summary_view()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>Self, invisibly.</p>
</div>

</div><p><hr>
<a id="method-SummaryReporter-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>SummaryReporter$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


SummaryReporter: Package Summary Reporter

Description

Arguments

Super class

Active bindings

Methods

Public methods

Method `get_summary_view()`

Usage

Returns

Method `clone()`

Usage

Arguments

See Also

Description

Arguments

Super class

Active bindings

Methods

Public methods

Method get_summary_view()

Usage

Returns

Method clone()

Usage

Arguments

See Also

Method `get_summary_view()`

Method `clone()`