P281424/AMR
1
0
Fork 0
mirror of https://github.com/msberends/AMR.git synced 2025-07-08 07:51:57 +02:00
Code Releases Activity

(v1.3.0.9039) lifecycle updates, added excess kurtosis

Browse Source
This commit is contained in:
dr. M.S. (Matthijs) Berends
2020-10-04 21:02:16 +02:00
parent baf510183c
commit c04dc852cf
30 changed files with 120 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/reference/kurtosis.html
View File

@ -49,7 +49,7 @@
<script src="../extra.js"></script>
<meta property="og:title" content="Kurtosis of the sample — kurtosis" />
<meta property="og:description" content="Kurtosis is a measure of the &quot;tailedness&quot; of the probability distribution of a real-valued random variable." />
<meta property="og:description" content="Kurtosis is a measure of the &quot;tailedness&quot; of the probability distribution of a real-valued random variable. A normal distribution has a kurtosis of 3 and a excess kurtosis of 0." />
<meta property="og:image" content="https://msberends.github.io/AMR/logo.png" />
@ -82,7 +82,7 @@
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">AMR (for R)</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Latest development version">1.4.0</span>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Latest development version">1.3.0.9039</span>
</span>
</div>
@ -239,19 +239,19 @@
</div>
<div class="ref-description">
<p>Kurtosis is a measure of the "tailedness" of the probability distribution of a real-valued random variable.</p>
<p>Kurtosis is a measure of the "tailedness" of the probability distribution of a real-valued random variable. A normal distribution has a kurtosis of 3 and a excess kurtosis of 0.</p>
</div>
<pre class="usage"><span class='fu'>kurtosis</span>(<span class='kw'>x</span>, na.rm = <span class='fl'>FALSE</span>)
<pre class="usage"><span class='fu'>kurtosis</span>(<span class='kw'>x</span>, na.rm = <span class='fl'>FALSE</span>, excess = <span class='fl'>FALSE</span>)
<span class='co'># S3 method for default</span>
<span class='fu'>kurtosis</span>(<span class='kw'>x</span>, na.rm = <span class='fl'>FALSE</span>)
<span class='fu'>kurtosis</span>(<span class='kw'>x</span>, na.rm = <span class='fl'>FALSE</span>, excess = <span class='fl'>FALSE</span>)
<span class='co'># S3 method for matrix</span>
<span class='fu'>kurtosis</span>(<span class='kw'>x</span>, na.rm = <span class='fl'>FALSE</span>)
<span class='fu'>kurtosis</span>(<span class='kw'>x</span>, na.rm = <span class='fl'>FALSE</span>, excess = <span class='fl'>FALSE</span>)
<span class='co'># S3 method for data.frame</span>
<span class='fu'>kurtosis</span>(<span class='kw'>x</span>, na.rm = <span class='fl'>FALSE</span>)</pre>
<span class='fu'>kurtosis</span>(<span class='kw'>x</span>, na.rm = <span class='fl'>FALSE</span>, excess = <span class='fl'>FALSE</span>)</pre>
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
<table class="ref-arguments">
@ -262,16 +262,21 @@
</tr>
<tr>
<th>na.rm</th>
<td><p>a logical value indicating whether <code>NA</code> values should be stripped before the computation proceeds.</p></td>
<td><p>a logical to indicate whether <code>NA</code> values should be stripped before the computation proceeds</p></td>
</tr>
<tr>
<th>excess</th>
<td><p>a logical to indicate whether the <em>excess kurtosis</em> should be returned, defined as the kurtosis minus 3.</p></td>
</tr>
</table>
<h2 class="hasAnchor" id="questioning-lifecycle"><a class="anchor" href="#questioning-lifecycle"></a>Questioning lifecycle</h2>
<h2 class="hasAnchor" id="stable-lifecycle"><a class="anchor" href="#stable-lifecycle"></a>Stable lifecycle</h2>
<p><img src='figures/lifecycle_questioning.svg' style=margin-bottom:5px /> <br />
The <a href='lifecycle.html'>lifecycle</a> of this function is <strong>questioning</strong>. This function might be no longer be optimal approach, or is it questionable whether this function should be in this <code>AMR</code> package at all.</p>
<p><img src='figures/lifecycle_stable.svg' style=margin-bottom:5px /> <br />
The <a href='lifecycle.html'>lifecycle</a> of this function is <strong>stable</strong>. In a stable function, major changes are unlikely. This means that the unlying code will generally evolve by adding new arguments; removing arguments or changing the meaning of existing arguments will be avoided.</p>
<p>If the unlying code needs breaking changes, they will occur gradually. For example, a parameter will be deprecated and first continue to work, but will emit an message informing you of the change. Next, typically after at least one newly released version on CRAN, the message will be transformed to an error.</p>
<h2 class="hasAnchor" id="read-more-on-our-website-"><a class="anchor" href="#read-more-on-our-website-"></a>Read more on our website!</h2>