diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 04b33ce..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-03-01T03:25:10.392Z diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 6adf06a..f56d473 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -110,9 +110,9 @@ jobs: exit 0 fi rm -rf ./bin/cli - rm test/test.cli.js - rm etc/cli_opts.json - rm docs/usage.txt + rm -f test/test.cli.js + rm -f etc/cli_opts.json + rm -f docs/usage.txt # For all dependencies, check in all *.js files if they are still used; if not, remove them: jq -r '.dependencies | keys[]' ./package.json | while read -r dep; do @@ -149,6 +149,12 @@ jobs: # Add link definition for CLI package to README.md: find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
/
\n\n[$escapedPkg]: https:\/\/www.npmjs.com\/package\/$escapedPkg/" + # Replace GitHub MathJax equations with SVGs: + - name: 'Replace GitHub MathJax equations with SVGs' + run: | + find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe 's/```math\n([\s\S]+?)\n```\n\n//g' + find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe 's/)/
/sg' + # Replace GitHub links to individual packages with npm links: - name: 'Replace all GitHub links to individual packages with npm links' run: | @@ -162,8 +168,8 @@ jobs: # Remove unnecessary files: - name: 'Remove unnecessary files' run: | - rm docs/repl.txt - rm docs/types/test.ts + rm -f docs/repl.txt + rm -f docs/types/test.ts # Replace all stdlib GitHub dependencies with the respective npm packages: - name: 'Replace all stdlib GitHub dependencies with the respective npm packages' diff --git a/CONTRIBUTORS b/CONTRIBUTORS index 2cb9b1c..34dfa68 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -29,4 +29,5 @@ Seyyed Parsa Neshaei Shraddheya Shendre Stephannie Jiménez Gacha dorrin-sot <59933477+dorrin-sot@users.noreply.github.com> +orimiles5 <97595296+orimiles5@users.noreply.github.com> rei2hu diff --git a/README.md b/README.md index ea93d01..8838468 100644 --- a/README.md +++ b/README.md @@ -30,10 +30,14 @@ For a window of size `W`, the [unbiased sample variance][sample-variance] is def -
+```math +s^2 = \frac{1}{W-1} \sum_{i=0}^{W-1} ( x_i - \bar{x} )^2 +``` + + @@ -41,10 +45,14 @@ and the [arithmetic mean][arithmetic-mean] is defined as -
+```math +\bar{x} = \frac{1}{W} \sum_{i=0}^{W-1} x_i +``` + + @@ -52,10 +60,14 @@ The [variance-to-mean ratio][variance-to-mean-ratio] (VMR) is thus defined as -
+```math +F = \frac{s^2}{\bar{x}} +``` + + @@ -263,7 +275,7 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. --> [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg -[chat-url]: https://gitter.im/stdlib-js/stdlib/ +[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im [stdlib]: https://github.com/stdlib-js/stdlib