time-to-botec

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

index.js (1323B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2020 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 independence test.
     23 *
     24 * @module @stdlib/stats/chi2test
     25 *
     26 * @example
     27 * var chi2test = require( '@stdlib/stats/chi2test' );
     28 *
     29 * var x = [ [ 20, 30 ], [ 30, 20 ] ];
     30 * var out = chi2test( x );
     31 * // returns { 'rejected': false, 'alpha': 0.05, 'pValue': ~0.072, ... }
     32 *
     33 * var table = out.print();
     34 * /*
     35 *     Chi-square independence test
     36 *
     37 *     Null hypothesis: the two variables are independent
     38 *
     39 *         pValue: 0.0719
     40 *         statistic: 3.24
     41 *         degrees of freedom: 1
     42 *
     43 *     Test Decision: Fail to reject null in favor of alternative at 5% significance level
     44 * /*
     45 */
     46 
     47 // MODULES //
     48 
     49 var chi2test = require( './main.js' );
     50 
     51 
     52 // EXPORTS //
     53 
     54 module.exports = chi2test;