docs: improve examples of stats/base/dists/studentized-range

kawakaze430 · Planeshifter · web-flow · commit 352993db5c4a · 2024-06-19T14:05:05.000-04:00
PR-URL: stdlib-js#2183 Closes: stdlib-js#1644 --------- Signed-off-by: Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com> Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
diff --git a/lib/node_modules/@stdlib/stats/base/dists/studentized-range/README.md b/lib/node_modules/@stdlib/stats/base/dists/studentized-range/README.md
@@ -65,10 +65,25 @@ The namespace contains the following distribution functions:
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var objectKeys = require( '@stdlib/utils/keys' );
 var tukey = require( '@stdlib/stats/base/dists/studentized-range' );
 
-console.log( objectKeys( tukey ) );
+/*
+* Let's consider an example where we are analyzing the test scores of students in a class.
+* We're interested in using the Studentized Range Distribution to analyze the range of scores.
+* The distribution has parameters: r (number of means), v (degrees of freedom), and nranges (number of ranges).
+*/
+
+var r = 5.0;
+var v = 20.0;
+var nranges = 3.0;
+
+// CDF can be used to calculate the cumulative distribution function at a specific value:
+var out = tukey.cdf( 2.0, r, v, nranges );
+// returns ~0.074
+
+// Quantile can also be used to calculate the quantile function at a specific probability:
+out = tukey.quantile( 0.9, r, v, nranges );
+// returns ~4.433
 ```
 
 </section>
diff --git a/lib/node_modules/@stdlib/stats/base/dists/studentized-range/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/studentized-range/examples/index.js
@@ -18,7 +18,22 @@
 
 'use strict';
 
-var objectKeys = require( '@stdlib/utils/keys' );
 var tukey = require( './../lib' );
 
-console.log( objectKeys( tukey ) );
+/*
+* Let's consider an example where we are analyzing the test scores of students in a class.
+* We're interested in using the Studentized Range Distribution to analyze the range of scores.
+* The distribution has parameters: r (number of means), v (degrees of freedom), and nranges (number of ranges).
+*/
+
+var r = 5.0;
+var v = 20.0;
+var nranges = 3.0;
+
+// CDF can be used to calculate the cumulative distribution function at a specific value:
+console.log( tukey.cdf( 2.0, r, v, nranges ) );
+// => ~0.074
+
+// Quantile can also be used to calculate the quantile function at a specific probability:
+console.log( tukey.quantile( 0.9, r, v, nranges ) );
+// => ~4.433
