w-statistic
Version:
A tool for statistical analysis.
176 lines (133 loc) • 6.24 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>arrQuartile.mjs - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
<script src="scripts/nav.js" defer></script>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav >
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="w-statistic.html">w-statistic</a><ul class='methods'><li data-type='method'><a href="w-statistic.html#.arrAverage">arrAverage</a></li><li data-type='method'><a href="w-statistic.html#.arrAverageWithLogNormCI">arrAverageWithLogNormCI</a></li><li data-type='method'><a href="w-statistic.html#.arrAverageWithNormCI">arrAverageWithNormCI</a></li><li data-type='method'><a href="w-statistic.html#.arrCount">arrCount</a></li><li data-type='method'><a href="w-statistic.html#.arrGammaFit">arrGammaFit</a></li><li data-type='method'><a href="w-statistic.html#.arrGammaHist">arrGammaHist</a></li><li data-type='method'><a href="w-statistic.html#.arrGammaInv">arrGammaInv</a></li><li data-type='method'><a href="w-statistic.html#.arrGeometricAverage">arrGeometricAverage</a></li><li data-type='method'><a href="w-statistic.html#.arrGeometricStd">arrGeometricStd</a></li><li data-type='method'><a href="w-statistic.html#.arrLogNormHist">arrLogNormHist</a></li><li data-type='method'><a href="w-statistic.html#.arrLogNormInv">arrLogNormInv</a></li><li data-type='method'><a href="w-statistic.html#.arrMovingAverage">arrMovingAverage</a></li><li data-type='method'><a href="w-statistic.html#.arrNormHist">arrNormHist</a></li><li data-type='method'><a href="w-statistic.html#.arrNormInv">arrNormInv</a></li><li data-type='method'><a href="w-statistic.html#.arrQuartile">arrQuartile</a></li><li data-type='method'><a href="w-statistic.html#.arrStd">arrStd</a></li><li data-type='method'><a href="w-statistic.html#.bin">bin</a></li><li data-type='method'><a href="w-statistic.html#.histGen">histGen</a></li><li data-type='method'><a href="w-statistic.html#.regLine">regLine</a></li><li data-type='method'><a href="w-statistic.html#.regMpLine">regMpLine</a></li><li data-type='method'><a href="w-statistic.html#.regPoly">regPoly</a></li><li data-type='method'><a href="w-statistic.html#.regPower">regPower</a></li><li data-type='method'><a href="w-statistic.html#.sampleRandom">sampleRandom</a></li><li data-type='method'><a href="w-statistic.html#.studentTInv">studentTInv</a></li></ul></li></ul>
</nav>
<div id="main">
<h1 class="page-title">arrQuartile.mjs</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>import size from 'lodash-es/size.js'
import isarr from 'wsemi/src/isarr.mjs'
import ispnum from 'wsemi/src/ispnum.mjs'
import cdbl from 'wsemi/src/cdbl.mjs'
import arrFilterByNum from 'wsemi/src/arrFilterByNum.mjs'
import ss from './simpleStatistics.mjs'
/**
* 計算陣列內有效數字之分位數值
*
* Unit Test: {@link https://github.com/yuda-lyu/w-statistic/blob/master/test/arrQuartile.test.js Github}
* @memberOf w-statistic
* @param {Array} arr 輸入陣列，只提取有效數字(或為字串的數字)進行計算
* @param {Number} ratio 輸入指定位置浮點數，需介於0至1之間
* @returns {Number} 回傳分位數值
* @example
*
* let arr
*
* arr = [3, 6, 7, 8, 8, 10, 13, 15, 16, 20]
* console.log(arrQuartile(arr, 0.25))
* // => 7
*
* arr = [3, 6, 7, 8, 8, 10, 13, 15, 16, 20]
* console.log(arrQuartile(arr, 0.5))
* // => 9
*
* arr = [3, 6, 7, 8, 8, 10, 13, 15, 16, 20]
* console.log(arrQuartile(arr, 0.75))
* // => 15
*
* arr = [1, 2, 3, 4, 5, 6]
* console.log(arrQuartile(arr, 0.25))
* // => 2
*
* arr = [3, 6, 7, 8, 8, 9, 10, 13, 15, 16, 20]
* console.log(arrQuartile(arr, 0.5))
* // => 9
*
* arr = [6, 47, 49, 15, 42, 41, 7, 39, 43, 40, 36]
* console.log(arrQuartile(arr, 0.25))
* // => 15
*
* arr = [6, 47, 49, 15, 42, 41, 7, 39, 43, 40, 36]
* console.log(arrQuartile(arr, 0.5))
* // => 40
*
* arr = [6, 47, 49, 15, 42, 41, 7, 39, 43, 40, 36]
* console.log(arrQuartile(arr, 0.75))
* // => 43
*
* arr = ['abc', '-2.5', -2.5, '-1', -1, '-0.1', -0.1, '0', 0, '0.1', 0.1, '1', 1, '2.5', 2.5, 22.5, 'xyz']
* console.log(arrQuartile(arr, 0.5))
* // => 0
*
* arr = ['abc', '0', 0, '0.1', 0.1, '1', 1, '2.5', 2.5, 22.5, 'xyz']
* console.log(arrQuartile(arr, 0.5))
* // => 1
*
*/
function arrQuartile(arr, ratio) {
//check arr
if (!isarr(arr)) {
return null
}
if (size(arr) === 0) {
return null
}
//check ratio
if (!ispnum(ratio)) {
return null
}
ratio = cdbl(ratio)
if (ratio < 0) {
ratio = 0
}
if (ratio > 1) {
ratio = 1
}
//rs
let rs = arrFilterByNum(arr)
//n
let n = size(rs)
//check
if (n === 0) {
return null
}
//quantile
let r = ss.quantile(rs, ratio) //simple-statistics會取最靠近的陣列內原始數據值
// let r = jt.quantile(rs, ratio) //jStat會取該分位數
return r
}
export default arrQuartile
</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Jul 29 2025 14:21:18 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/polyfill.js"></script>
<script src="scripts/linenumber.js"></script>
</body>
</html>