Updated Readme.md

Author: 23f3001304

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

@@ -18,7 +18,7 @@ limitations under the License.
 
 -->
 
-# incrmvmr
+# incrnanmvmr
 
 > Compute a moving [variance-to-mean ratio][variance-to-mean-ratio] (VMR) incrementally.
 
@@ -33,7 +33,7 @@ s^2 = \frac{1}{W-1} \sum_{i=0}^{W-1} ( x_i - \bar{x} )^2
 ```
 
 <!-- <div class="equation" align="center" data-raw-text="s^2 = \frac{1}{W-1} \sum_{i=0}^{W-1} ( x_i - \bar{x} )^2" data-equation="eq:unbiased_sample_variance">
-    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@b331e5634fe726ff0e16e87814ac3f85d8164d31/lib/node_modules/@stdlib/stats/incr/mvmr/docs/img/equation_unbiased_sample_variance.svg" alt="Equation for the unbiased sample variance.">
+    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@b331e5634fe726ff0e16e87814ac3f85d8164d31/lib/node_modules/@stdlib/stats/incr/nanmvmr/docs/img/equation_unbiased_sample_variance.svg" alt="Equation for the unbiased sample variance.">
     <br>
 </div> -->
 
@@ -48,7 +48,7 @@ and the [arithmetic mean][arithmetic-mean] is defined as
 ```
 
 <!-- <div class="equation" align="center" data-raw-text="\bar{x} = \frac{1}{W} \sum_{i=0}^{W-1} x_i" data-equation="eq:arithmetic_mean">
-    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@164b8f1010c4535340eed9ad0b2af32c4a19863c/lib/node_modules/@stdlib/stats/incr/mvmr/docs/img/equation_arithmetic_mean.svg" alt="Equation for the arithmetic mean.">
+    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@164b8f1010c4535340eed9ad0b2af32c4a19863c/lib/node_modules/@stdlib/stats/incr/nanmvmr/docs/img/equation_arithmetic_mean.svg" alt="Equation for the arithmetic mean.">
     <br>
 </div> -->
 
@@ -63,7 +63,7 @@ F = \frac{s^2}{\bar{x}}
 ```
 
 <!-- <div class="equation" align="center" data-raw-text="F = \frac{s^2}{\bar{x}}" data-equation="eq:variance_to_mean_ratio">
-    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@b331e5634fe726ff0e16e87814ac3f85d8164d31/lib/node_modules/@stdlib/stats/incr/mvmr/docs/img/equation_variance_to_mean_ratio.svg" alt="Equation for the variance-to-mean ratio (VMR).">
+    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@b331e5634fe726ff0e16e87814ac3f85d8164d31/lib/node_modules/@stdlib/stats/incr/nanmvmr/docs/img/equation_variance_to_mean_ratio.svg" alt="Equation for the variance-to-mean ratio (VMR).">
     <br>
 </div> -->
 
@@ -78,29 +78,29 @@ F = \frac{s^2}{\bar{x}}
 ## Usage
 
 ```javascript
-var incrmvmr = require( '@stdlib/stats/incr/mvmr' );
+var incrnanmvmr = require( '@stdlib/stats/incr/nanmvmr' );
 ```
 
-#### incrmvmr( window\[, mean] )
+#### incrnanmvmr( window\[, mean] )
 
 Returns an accumulator `function` which incrementally computes a moving [variance-to-mean ratio][variance-to-mean-ratio]. The `window` parameter defines the number of values over which to compute the moving [variance-to-mean ratio][variance-to-mean-ratio].
 
 ```javascript
-var accumulator = incrmvmr( 3 );
+var accumulator = incrnanmvmr( 3 );
 ```
 
 If the mean is already known, provide a `mean` argument.
 
 ```javascript
-var accumulator = incrmvmr( 3, 5.0 );
+var accumulator = incrnanmvmr( 3, 5.0 );
 ```
 
 #### accumulator( \[x] )
 
 If provided an input value `x`, the accumulator function returns an updated accumulated value. If not provided an input value `x`, the accumulator function returns the current accumulated value.
 
 ```javascript
-var accumulator = incrmvmr( 3 );
+var accumulator = incrnanmvmr( 3 );
 
 var F = accumulator();
 // returns null
@@ -134,8 +134,6 @@ F = accumulator();
 
 ## Notes
 
--   Input values are **not** type checked. If provided `NaN` or a value which, when used in computations, results in `NaN`, the accumulated value is `NaN` for **at least** `W-1` future invocations. If non-numeric inputs are possible, you are advised to type check and handle accordingly **before** passing the value to the accumulator function.
-
 -   As `W` values are needed to fill the window buffer, the first `W-1` returned values are calculated from smaller sample sizes. Until the window is full, each returned value is calculated from all provided values.
 
 -   The following table summarizes how to interpret the [variance-to-mean ratio][variance-to-mean-ratio]:
@@ -165,18 +163,18 @@ F = accumulator();
 
 ```javascript
 var randu = require( '@stdlib/random/base/randu' );
-var incrmvmr = require( '@stdlib/stats/incr/mvmr' );
+var incrnanmvmr = require( '@stdlib/stats/incr/nanmvmr' );
 
 var accumulator;
 var v;
 var i;
 
 // Initialize an accumulator:
-accumulator = incrmvmr( 5 );
+accumulator = incrnanmvmr( 5 );
 
 // For each simulated datum, update the moving variance-to-mean ratio...
 for ( i = 0; i < 100; i++ ) {
-    v = randu() * 100.0;
+    v = randu()> 0.2 ? NaN : randu() * 100.0;
     accumulator( v );
 }
 console.log( accumulator() );