Skip to content

Commit 01dae5b

Browse files
committed
Update examples
1 parent 4244221 commit 01dae5b

File tree

4 files changed

+11
-9
lines changed

4 files changed

+11
-9
lines changed

lib/node_modules/@stdlib/stats/incr/vmr/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,8 @@ D = accumulator();
124124

125125
Accordingly, one can use the [variance-to-mean ratio][variance-to-mean-ratio] to assess whether observed data can be modeled as a Poisson process. When observed data is "under-dispersed", observed data may be more regular than as would be the case for a Poisson process. When observed data is "over-dispersed", observed data may contain clusters (i.e., clumped, concentrated data).
126126

127+
- The [variance-to-mean ratio][variance-to-mean-ratio] is typically computed on non-negative values. The measure may lack meaning for data which can assume both positive and negative values.
128+
127129
- The [variance-to-mean ratio][variance-to-mean-ratio] is also known as the **index of dispersion**, **dispersion index**, **coefficient of dispersion**, and **relative variance**.
128130

129131
</section>

lib/node_modules/@stdlib/stats/incr/vmr/docs/repl.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@
2727
null
2828
> D = accumulator( 2.0 )
2929
0.0
30-
> D = accumulator( -4.0 )
31-
-24.5
30+
> D = accumulator( 1.0 )
31+
~0.33
3232
> D = accumulator()
33-
-24.5
33+
~0.33
3434

3535
See Also
3636
--------

lib/node_modules/@stdlib/stats/incr/vmr/lib/index.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@
3434
* D = accumulator( 2.0 );
3535
* // returns 0.0
3636
*
37-
* D = accumulator( -4.0 );
38-
* // returns -24.5
37+
* D = accumulator( 1.0 );
38+
* // returns ~0.33
3939
*
4040
* D = accumulator();
41-
* // returns -24.5
41+
* // returns ~0.33
4242
*/
4343

4444
// MODULES //

lib/node_modules/@stdlib/stats/incr/vmr/lib/main.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,11 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' );
7878
* D = accumulator( 2.0 );
7979
* // returns 0.0
8080
*
81-
* D = accumulator( -4.0 );
82-
* // returns -24.5
81+
* D = accumulator( 1.0 );
82+
* // returns ~0.33
8383
*
8484
* D = accumulator();
85-
* // returns -24.5
85+
* // returns ~0.33
8686
*
8787
* @example
8888
* var accumulator = incrvmr( 3.14 );

0 commit comments

Comments
 (0)