Sign

paired.sign

<p>Performs two-sample sign test on samples.</p>

Implements non-parametric tests from Higgins (2004, ISBN:0534387756), including tests for one-sample, two-sample, k-sample, paired, randomized complete block design, correlation and contingency tables. Built with 'Rcpp' for efficiency and 'R6' for flexible, object-oriented design, the package provides a unified framework for performing or creating custom permutation tests.

Yan Du

LearnNonparam

R6-Based Flexible Framework for Permutation Tests

Sign function

<p><code>LearnNonparam::PermuTest</code> -&gt; <code>LearnNonparam::TwoSampleTest</code> -&gt; <code>LearnNonparam::TwoSamplePairedTest</code> -&gt; <code>Sign</code></p>

Super classes

<p><div class="r6-active-bindings"></div></p><dl>
<dt><code>correct</code></dt>
<dd><p>Whether to apply continuity correction.</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/Sign%24new()?package=LearnNonparam&version=1.2.3" data-mini-rdoc="LearnNonparam::Sign$new()"><code>Sign$new()</code></a></p></li>
</ul></p><p></p></div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="LearnNonparam" data-topic="PermuTest" data-id="plot"><a href="/link/LearnNonparam%3A%3APermuTest%24plot()?package=LearnNonparam&version=1.2.3" data-mini-rdoc="LearnNonparam::LearnNonparam::PermuTest$plot()"><code>LearnNonparam::PermuTest$plot()</code></a></span></li>
<li><span class="pkg-link" data-pkg="LearnNonparam" data-topic="PermuTest" data-id="print"><a href="/link/LearnNonparam%3A%3APermuTest%24print()?package=LearnNonparam&version=1.2.3" data-mini-rdoc="LearnNonparam::LearnNonparam::PermuTest$print()"><code>LearnNonparam::PermuTest$print()</code></a></span></li>
<li><span class="pkg-link" data-pkg="LearnNonparam" data-topic="PermuTest" data-id="test"><a href="/link/LearnNonparam%3A%3APermuTest%24test()?package=LearnNonparam&version=1.2.3" data-mini-rdoc="LearnNonparam::LearnNonparam::PermuTest$test()"><code>LearnNonparam::PermuTest$test()</code></a></span></li>
</ul>
</details></p><p><hr>
<a id="method-Sign-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Create a new <code>Sign</code> object.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Sign$new(
  type = c("permu", "asymp"),
  alternative = c("two_sided", "less", "greater"),
  n_permu = 10000,
  correct = TRUE
)</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>type</code></dt>
<dd><p>a character string specifying the way to calculate the p-value.</p></dd></dl></div></p><p>
<dt><code>alternative</code></dt>
<dd><p>a character string specifying the alternative hypothesis.</p></dd></p><p>
<dt><code>n_permu</code></dt>
<dd><p>an integer indicating number of permutations for the permutation distribution. If set to zero (default) then all permutations are used.</p></dd></p><p>
<dt><code>correct</code></dt>
<dd><p>a logical indicating whether to apply continuity correction in the normal approximation for the p-value.</p></dd></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>A <code>Sign</code> object.</p>
</div><p></p><p>
</p>

Methods

Two-Sample Sign Test — Sign

<p><div class="r6-active-bindings"></p><dl>
<dt><code>correct</code></dt>
<dd><p>Whether to apply continuity correction.</p></dd>


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


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

<ul>
<li><p><a href='#method-Sign-new'><code>Sign$new()</code></a></p></li>
</ul>

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

<hr>
<a id="method-Sign-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Create a new <code>Sign</code> object.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Sign$new(
  type = c("permu", "asymp"),
  alternative = c("two_sided", "less", "greater"),
  n_permu = 10000,
  correct = TRUE
)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>type</code></dt>
<dd><p>a character string specifying the way to calculate the p-value.</p></dd>


<dt><code>alternative</code></dt>
<dd><p>a character string specifying the alternative hypothesis.</p></dd>


<dt><code>n_permu</code></dt>
<dd><p>an integer indicating number of permutations for the permutation distribution. If set to zero (default) then all permutations are used.</p></dd>


<dt><code>correct</code></dt>
<dd><p>a logical indicating whether to apply continuity correction in the normal approximation for the p-value.</p></dd>


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

</div>


Sign: Two-Sample Sign Test

Description

Arguments

Super classes

Active bindings

Methods

Public methods

Method `new()`

Usage

Arguments

Returns

Examples

Description

Arguments

Super classes

Active bindings

Methods

Public methods

Method new()

Usage

Arguments

Returns

Examples

Method `new()`