Edge

<p>An R6 class representing an edge in a graph.</p>

Classes and functions for modelling health care interventions
using decision trees and semi-Markov models. Mechanisms are provided for
associating an uncertainty distribution with each source variable and for
ensuring transparency of the mathematical relationships between variables.
The package terminology follows Briggs "Decision Modelling for Health
Economic Evaluation" (2006, ISBN:978-0-19-852662-9).

Andrew Sims

rdecision

Decision Analytic Modelling in Health Economics

Kim Fairbairn

Paola Cognigni

Edge function

<p>Andrew J. Sims <a href="/link/andrew.sims%40newcastle.ac.uk?package=rdecision&version=1.1.2" data-mini-rdoc="rdecision::andrew.sims@newcastle.ac.uk">andrew.sims@newcastle.ac.uk</a></p>

Author


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/Edge%24new()?package=rdecision&version=1.1.2" data-mini-rdoc="rdecision::Edge$new()"><code>Edge$new()</code></a></p></li>
<li><p><a href="/link/Edge%24is_same_edge()?package=rdecision&version=1.1.2" data-mini-rdoc="rdecision::Edge$is_same_edge()"><code>Edge$is_same_edge()</code></a></p></li>
<li><p><a href="/link/Edge%24endpoints()?package=rdecision&version=1.1.2" data-mini-rdoc="rdecision::Edge$endpoints()"><code>Edge$endpoints()</code></a></p></li>
<li><p><a href="/link/Edge%24label()?package=rdecision&version=1.1.2" data-mini-rdoc="rdecision::Edge$label()"><code>Edge$label()</code></a></p></li>
<li><p><a href="/link/Edge%24clone()?package=rdecision&version=1.1.2" data-mini-rdoc="rdecision::Edge$clone()"><code>Edge$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-Edge-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Create an object of type <code>Edge</code>.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Edge$new(v1, v2, label = "")</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>v1</code></dt>
<dd><p>Node at one endpoint of the edge.</p></dd></dl></div></p><p>
<dt><code>v2</code></dt>
<dd><p>Node at the other endpoint of the edge.</p></dd></p><p>
<dt><code>label</code></dt>
<dd><p>Character string containing the edge label.</p></dd></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>A new <code>Edge</code> object.</p>
</div><p></p><p></p><p><hr>
<a id="method-Edge-is_same_edge"></a></p><div class="section" id="method-is-same-edge-">
<h3>Method <code>is_same_edge()</code></h3>
<p>Is this edge the same as the argument?</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Edge$is_same_edge(e)</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>e</code></dt>
<dd><p>edge to compare with this one</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p><code>TRUE</code> if <code>e</code> is also this one.</p>
</div><p></p><p></p><p><hr>
<a id="method-Edge-endpoints"></a></p><div class="section" id="method-endpoints-">
<h3>Method <code>endpoints()</code></h3>
<p>Retrieve the endpoints of the edge.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Edge$endpoints()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>List of two nodes to which the edge is connected.</p>
</div></p><p></p><p><hr>
<a id="method-Edge-label"></a></p><div class="section" id="method-label-">
<h3>Method <code>label()</code></h3>
<p>Access label.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Edge$label()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>Label of the edge; character string.</p>
</div></p><p></p><p><hr>
<a id="method-Edge-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>Edge$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

An edge in a graph — Edge

<p>Andrew J. Sims <a href='mailto:andrew.sims@newcastle.ac.uk'>andrew.sims@newcastle.ac.uk</a></p>


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

<ul>
<li><p><a href='#method-Edge-new'><code>Edge$new()</code></a></p></li>
<li><p><a href='#method-Edge-is_same_edge'><code>Edge$is_same_edge()</code></a></p></li>
<li><p><a href='#method-Edge-endpoints'><code>Edge$endpoints()</code></a></p></li>
<li><p><a href='#method-Edge-label'><code>Edge$label()</code></a></p></li>
<li><p><a href='#method-Edge-clone'><code>Edge$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-Edge-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Create an object of type <code>Edge</code>.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Edge$new(v1, v2, label = "")</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>v1</code></dt>
<dd><p>Node at one endpoint of the edge.</p></dd>


<dt><code>v2</code></dt>
<dd><p>Node at the other endpoint of the edge.</p></dd>


<dt><code>label</code></dt>
<dd><p>Character string containing the edge label.</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>A new <code>Edge</code> object.</p>
</div>

</div><p><hr>
<a id="method-Edge-is_same_edge"></a></p><div class='section' id='method-is-same-edge-'>
<h3>Method <code>is_same_edge()</code></h3>
<p>Is this edge the same as the argument?</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Edge$is_same_edge(e)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>e</code></dt>
<dd><p>edge to compare with this one</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p><code>TRUE</code> if <code>e</code> is also this one.</p>
</div>

</div><p><hr>
<a id="method-Edge-endpoints"></a></p><div class='section' id='method-endpoints-'>
<h3>Method <code>endpoints()</code></h3>
<p>Retrieve the endpoints of the edge.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Edge$endpoints()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>List of two nodes to which the edge is connected.</p>
</div>

</div><p><hr>
<a id="method-Edge-label"></a></p><div class='section' id='method-label-'>
<h3>Method <code>label()</code></h3>
<p>Access label.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Edge$label()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>Label of the edge; character string.</p>
</div>

</div><p><hr>
<a id="method-Edge-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>Edge$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>


Edge: An edge in a graph

Description

Arguments

Author

Methods

Public methods

Method `new()`

Usage

Arguments

Returns

Method `is_same_edge()`

Usage

Arguments

Returns

Method `endpoints()`

Usage

Returns

Method `label()`

Usage

Returns

Method `clone()`

Usage

Arguments

Details

Description

Arguments

Author

Methods

Public methods

Method new()

Usage

Arguments

Returns

Method is_same_edge()

Usage

Arguments

Returns

Method endpoints()

Usage

Returns

Method label()

Usage

Returns

Method clone()

Usage

Arguments

Details

Method `new()`

Method `is_same_edge()`

Method `endpoints()`

Method `label()`

Method `clone()`