time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

index.js (1332B)


      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 /**
     22 * Chi-square goodness-of-fit test.
     23 *
     24 * @module @stdlib/stats/chi2gof
     25 *
     26 * @example
     27 * var chi2gof = require( '@stdlib/stats/chi2gof' );
     28 * var x = [ 89, 37, 30, 28, 2 ];
     29 * var p = [ 0.40, 0.20, 0.20, 0.15, 0.05 ];
     30 *
     31 * var out = chi2gof( x, p );
     32 *
     33 * var o = out.toJSON();
     34 * // returns { 'pValue': ~0.0406, 'statistic': ~9.9901, ... }
     35 *
     36 * var table = out.toString();
     37 * /*
     38 * Null hypothesis: population probabilities are equal to those in p
     39 *
     40 *     pValue: 0.0406
     41 *     statistic: 9.9901
     42 *     degrees of freedom: 4
     43 *
     44 * Test Decision: Reject null in favor of alternative at 5% significance level
     45 * /*
     46 */
     47 
     48 // MODULES //
     49 
     50 var chi2gof = require( './main.js' );
     51 
     52 
     53 // EXPORTS //
     54 
     55 module.exports = chi2gof;