Commit 42773350 authored by Thomas Friedrichsmeier's avatar Thomas Friedrichsmeier
Browse files

Add at least a minimal help page to all distribution plugins. Some minor adjustments.

Left to do: Testing, and writing automated tests.
parent 227ed913
......@@ -67,6 +67,7 @@ function calculate () {
values = 'seq (' + String (dist["min"]) + ', ' + String (dist["max"]) + ', length.out=' + String (max_auto_sequence_length) + ')';
}
} else { // invar == 'p'
max_auto_sequence_length += 1; // here, an uneven number is preferrable for divisibility of steps by 2
if (logpd) {
values = '-' + String (max_auto_sequence_length) + ':0';
} else {
......
<!DOCTYPE rkhelp>
<document>
<snippets>
<include file="dist_help_snippets.xml"/>
</snippets>
<summary>
Provides a calculator for probabilities, quantiles, and densities in the Gumbel distribution.
</summary>
<insert snippet="dialog_usage"/>
<settings>
<insert snippet="dialog_settings"/>
<setting id="location">Location parameter.</setting>
<setting id="scale">Scale parameter.</setting>
</settings>
<related>
<ul>
<li><link href="rkward://rhelp/pgumgel">R help on the gumbel distribution functions from package FAdist</li>
<li><link href="rkward://component/rkward/plot_gumbel_distribution"/></li>
</ul>
</related>
</document>
<!DOCTYPE rkhelp>
<document>
<snippets>
<include file="dist_help_snippets.xml"/>
</snippets>
<summary>
Provides a calculator for probabilities, quantiles, and densities in the Hypergeometric distribution.
Quantiles represent the number of white balls drawn in k draws without replacement from an urn containing m white and n black balls.
</summary>
<insert snippet="dialog_usage"/>
<settings>
<insert snippet="dialog_settings"/>
<setting id="m">m (Number of white balls in the urn)</setting>
<setting id="n">n (Number of black balls in the urn)</setting>
<setting id="k">k (Number of draws from the urn)</setting>
</settings>
<related>
<ul>
<li><link href="rkward://rhelp/Hypergeometric"/></li>
<li><link href="rkward://component/rkward/plot_hypergeom_distribution"/></li>
</ul>
</related>
</document>
<!DOCTYPE rkhelp>
<document>
<snippets>
<include file="dist_help_snippets.xml"/>
</snippets>
<summary>
Provides a calculator for probabilities, quantiles, and densities in the Log-Normal distribution.
</summary>
<insert snippet="dialog_usage"/>
<settings>
<insert snippet="dialog_settings"/>
<setting id="meanlog">meanlog (mean of the distribution on the log scale)</setting>
<setting id="sdlog">sdlog (standard deviation of the distribution on the log scale)</setting>
</settings>
<related>
<ul>
<li><link href="rkward://rhelp/Lognormal"/></li>
<li><link href="rkward://component/rkward/plot_lognormal_distribution"/></li>
</ul>
</related>
</document>
<!DOCTYPE rkhelp>
<document>
<snippets>
<include file="dist_help_snippets.xml"/>
</snippets>
<summary>
Provides a calculator for probabilities, quantiles, and densities in the logistic distribution.
</summary>
<insert snippet="dialog_usage"/>
<settings>
<insert snippet="dialog_settings"/>
<setting id="location">Location parameter μ (corresponds to the mean).</setting>
<setting id="scale">Scale parameter.</setting>
</settings>
<related>
<ul>
<li><link href="rkward://rhelp/Logistic"/></li>
<li><link href="rkward://component/rkward/plot_logistic_distribution"/></li>
</ul>
</related>
</document>
<!DOCTYPE rkhelp>
<document>
<snippets>
<include file="dist_help_snippets.xml"/>
</snippets>
<summary>
Provides a calculator for probabilities, quantiles, and densities in the Negative Binomial distribution.
Note: Quantiles represents the number of failures in a sequence of Bernoulli trials before the target number of successes is reached.
</summary>
<insert snippet="dialog_usage"/>
<settings>
<insert snippet="dialog_settings"/>
<setting id="size">Target number of successes. This need not be an integer.</setting>
<setting id="prob">Probability of success in each trial. Note that this setting is <b>not</b> affected by the "log probabilities" setting, i.e. always specify the plain probability.</setting>
</settings>
<related>
<ul>
<li><link href="rkward://rhelp/NegBinomial"/></li>
<li><link href="rkward://component/rkward/plot_negbinomial_distribution"/></li>
</ul>
</related>
</document>
......@@ -10,8 +10,8 @@
</logic>
<snippets>
<snippet id="dist_options">
<spinbox type="integer" min="0" initial="5" id="size" label="Target for number of successful trials"/>
<spinbox default_precision="2" type="real" min="0" initial="0.5" max="1" id="prob" label="Probability of success in each trial"/>
<spinbox default_precision="0" type="real" min="0" initial="5" id="size" label="Target number of successful trials"/>
<spinbox default_precision="1" type="real" min="0" initial="0.5" max="1" id="prob" label="Probability of success in each trial"/>
</snippet>
<include file="dist_snippets.xml"/>
</snippets>
......
include ("dist_common.js");
function getDistSpecifics () {
return initDistSpecifics (i18n ('Normal distribution'), 'norm', ["mean", "sd"], [-4, 4], continous);
return initDistSpecifics (i18n ('Normal distribution'), 'norm', ["mean", "sd"], [-4, 4], continuous);
}
<!DOCTYPE rkhelp>
<document>
<snippets>
<include file="dist_help_snippets.xml"/>
</snippets>
<summary>
Provides a calculator for probabilities, quantiles, and densities in the Normal distribution.
</summary>
<insert snippet="dialog_usage"/>
<settings>
<insert snippet="dialog_settings"/>
<setting id="mean">Mean.</setting>
<setting id="prob">Standard deviation.</setting>
</settings>
<related>
<ul>
<li><link href="rkward://rhelp/Normal"/></li>
<li><link href="rkward://component/rkward/plot_normal_distribution"/></li>
</ul>
Various tests for normality of observed measures are available, for instance <link href="rkward://component/rkward/jb_test"/>.
</related>
</document>
......@@ -20,6 +20,7 @@ Density and distribution function plots for the Binomial distribution.
<related>
<ul>
<li><link href="rkward://component/binomial_probabilities"/></li>
<li><link href="rkward://rhelp/Binomial"/></li>
<li><link href="rkward://component/plot_options"/></li>
<li><link href="rkward://rhelp/curve"/></li>
......
......@@ -19,6 +19,7 @@ Density and distribution function plots for the Cauchy distribution.
</settings>
<related>
<ul>
<li><link href="rkward://component/cauchy_probabilities"/></li>
<li><link href="rkward://rhelp/Cauchy"/></li>
<li><link href="rkward://component/plot_options"/></li>
<li><link href="rkward://rhelp/curve"/></li>
......
......@@ -20,6 +20,7 @@ Density and distribution function plots for the Chi-squared distribution.
<related>
<ul>
<li><link href="rkward://component/chi_squared_probabilities"/></li>
<li><link href="rkward://rhelp/Chisquare"/></li>
<li><link href="rkward://component/plot_options"/></li>
<li><link href="rkward://rhelp/curve"/></li>
......
......@@ -18,6 +18,7 @@ Density and distribution function plots for the Exponential distribution.
</settings>
<related>
<ul>
<li><link href="rkward://component/exponential_probabilities"/></li>
<li><link href="rkward://rhelp/Exponential"/></li>
<li><link href="rkward://component/plot_options"/></li>
<li><link href="rkward://rhelp/curve"/></li>
......
......@@ -21,6 +21,7 @@ Density and distribution function plots for the F distribution.
<related>
<ul>
<li><link href="rkward://component/f_probabilities"/></li>
<li><link href="rkward://rhelp/FDist"/></li>
<li><link href="rkward://component/plot_options"/></li>
<li><link href="rkward://rhelp/curve"/></li>
......
......@@ -20,6 +20,7 @@ Density and distribution function plots for the Gamma distribution.
<related>
<ul>
<li><link href="rkward://component/gamma_probabilities"/></li>
<li><link href="rkward://rhelp/GammaDist"/></li>
<li><link href="rkward://component/plot_options"/></li>
<li><link href="rkward://rhelp/curve"/></li>
......
......@@ -19,6 +19,7 @@ Density and distribution function plots for the Geometric distribution.
<related>
<ul>
<li><link href="rkward://component/geometric_probabilities"/></li>
<li><link href="rkward://rhelp/Geometric"/></li>
<li><link href="rkward://component/plot_options"/></li>
<li><link href="rkward://rhelp/curve"/></li>
......
......@@ -21,6 +21,7 @@ Density and distribution function plots for the Hypergeometric distribution.
<related>
<ul>
<li><link href="rkward://component/hypergeometric_probabilities"/></li>
<li><link href="rkward://rhelp/Hypergeometric"/></li>
<li><link href="rkward://component/plot_options"/></li>
<li><link href="rkward://rhelp/curve"/></li>
......
......@@ -20,6 +20,7 @@ Density and distribution function plots for the Logistic distribution.
<related>
<ul>
<li><link href="rkward://component/logistic_probabilities"/></li>
<li><link href="rkward://rhelp/Logistic"/></li>
<li><link href="rkward://component/plot_options"/></li>
<li><link href="rkward://rhelp/curve"/></li>
......
......@@ -20,6 +20,7 @@ Density and distribution function plots for the Lognormal distribution.
<related>
<ul>
<li><link href="rkward://component/lognormal_probabilities"/></li>
<li><link href="rkward://rhelp/Lognormal"/></li>
<li><link href="rkward://component/plot_options"/></li>
<li><link href="rkward://rhelp/curve"/></li>
......
......@@ -23,6 +23,7 @@ Density and distribution function plots for the Negative Binomial distribution.
<related>
<ul>
<li><link href="rkward://component/negative_binomial_probabilities"/></li>
<li><link href="rkward://rhelp/NegBinomial"/></li>
<li><link href="rkward://component/plot_options"/></li>
<li><link href="rkward://rhelp/curve"/></li>
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment