Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-06-08)
+## Unreleased (2024-06-19)
 
 <section class="packages">
 
@@ -74,6 +74,7 @@ A total of 7 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`352993d`](https://github.com/stdlib-js/stdlib/commit/352993db5c4a41180aa78951a0bc1c9faa8aefc4) - **docs:** improve examples of `stats/base/dists/studentized-range` _(by Rejoan Sardar, Philipp Burckhardt)_
 -   [`cc5d91f`](https://github.com/stdlib-js/stdlib/commit/cc5d91fb3df5155821344d6fffbeef23f37e8153) - **style:** remove blank line [(#2339)](https://github.com/stdlib-js/stdlib/pull/2339) _(by stdlib-bot, Philipp Burckhardt)_
 -   [`922122e`](https://github.com/stdlib-js/stdlib/commit/922122e319c37170f16e14ce5d074273fd7f0675) - **docs:** improve examples for `stats/base/dists/normal` namespace _(by NightKnight, Philipp Burckhardt)_
 -   [`c3ebfa8`](https://github.com/stdlib-js/stdlib/commit/c3ebfa80e311db338b171ebf8eb5f46bc66e9bf6) - **docs:** update namespace table of contents and address spelling errors _(by Philipp Burckhardt)_

CONTRIBUTORS

@@ -63,6 +63,7 @@ Pushpendra Chandravanshi <[email protected]>
 Raunak Kumar Gupta <[email protected]>
 Rejoan Sardar <[email protected]>
 Ricky Reusser <[email protected]>
+Ridam Garg <[email protected]>
 Robert Gislason <[email protected]>
 Roman Stetsyk <[email protected]>
 Rutam <[email protected]>
@@ -75,7 +76,7 @@ Shraddheya Shendre <[email protected]>
 Shubh Mehta <[email protected]>
 Shubham Mishra <[email protected]>
 Sivam Das <[email protected]>
-Snehil Shah <[email protected].com>
+Snehil Shah <snehilshah.989@gmail.com>
 Soumajit Chatterjee <[email protected]>
 Spandan Barve <[email protected]>
 Stephannie Jiménez Gacha <[email protected]>

LICENSE

@@ -180,44 +180,14 @@ DEPENDENCIES & ATTRIBUTION
 The library links against the following external libraries or contains
 implementations from the following external libraries, which have their own
 licenses:
-
-* Boost <http://www.boost.org/LICENSE_1_0.txt>
-
-Boost Software License - Version 1.0 - August 17th, 2003
-
-Permission is hereby granted, free of charge, to any person or organization
-obtaining a copy of the software and accompanying documentation covered by
-this license (the "Software") to use, reproduce, display, distribute,
-execute, and transmit the Software, and to prepare derivative works of the
-Software, and to permit third-parties to whom the Software is furnished to
-do so, all subject to the following:
-
-The copyright notices in the Software and this entire statement, including
-the above license grant, this restriction and the following disclaimer,
-must be included in all copies of the Software, in whole or in part, and
-all derivative works of the Software, unless such copies or derivative
-works are solely in the form of machine-executable object code generated by
-a source language processor.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
-SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
-FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
-ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-DEALINGS IN THE SOFTWARE.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
-SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
-FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
-ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-DEALINGS IN THE SOFTWARE.
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
 
+The library links against the following external libraries or contains
+implementations from the following external libraries, which have their own
+licenses:
+
 * StatsFuns.jl <https://raw.githubusercontent.com/JuliaStats/StatsFuns.jl/
 e66dd973650c375bc1739c820e5b96bb5bd000a8/LICENSE.md>
 
@@ -242,3 +212,29 @@ CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+* Boost <http://www.boost.org/LICENSE_1_0.txt>
+
+Boost Software License - Version 1.0 - August 17th, 2003
+
+Permission is hereby granted, free of charge, to any person or organization
+obtaining a copy of the software and accompanying documentation covered by
+this license (the "Software") to use, reproduce, display, distribute,
+execute, and transmit the Software, and to prepare derivative works of the
+Software, and to permit third-parties to whom the Software is furnished to
+do so, all subject to the following:
+
+The copyright notices in the Software and this entire statement, including
+the above license grant, this restriction and the following disclaimer,
+must be included in all copies of the Software, in whole or in part, and
+all derivative works of the Software, unless such copies or derivative
+works are solely in the form of machine-executable object code generated by
+a source language processor.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+

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>

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