Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Aug 19, 2021
1 parent 2c8ef48 commit f77be38
Show file tree
Hide file tree
Showing 11 changed files with 84 additions and 47 deletions.
61 changes: 42 additions & 19 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -29,74 +29,92 @@ trim_trailing_whitespace = true
insert_final_newline = true

# Set properties for JavaScript files:
[*.js]
[*.{js,js.txt}]
indent_style = tab

# Set properties for JavaScript ES module files:
[*.{mjs,mjs.txt}]
indent_style = tab

# Set properties for JavaScript CommonJS files:
[*.{cjs,cjs.txt}]
indent_style = tab

# Set properties for JSON files:
[*.{json,json.txt}]
indent_style = space
indent_size = 2

# Set properties for TypeScript files:
[*.ts]
indent_style = tab

# Set properties for Python files:
[*.py]
[*.{py,py.txt}]
indent_style = space
indent_size = 4

# Set properties for Julia files:
[*.jl]
[*.{jl,jl.txt}]
indent_style = tab

# Set properties for R files:
[*.R]
[*.{R,R.txt}]
indent_style = tab

# Set properties for C files:
[*.c]
[*.{c,c.txt}]
indent_style = tab

# Set properties for C header files:
[*.h]
[*.{h,h.txt}]
indent_style = tab

# Set properties for C++ files:
[*.cpp]
[*.{cpp,cpp.txt}]
indent_style = tab

# Set properties for C++ header files:
[*.hpp]
[*.{hpp,hpp.txt}]
indent_style = tab

# Set properties for Fortran files:
[*.f]
[*.{f,f.txt}]
indent_style = space
indent_size = 2
insert_final_newline = false

# Set properties for shell files:
[*.sh]
[*.{sh,sh.txt}]
indent_style = tab

# Set properties for AWK files:
[*.awk]
[*.{awk,awk.txt}]
indent_style = tab

# Set properties for HTML files:
[*.html]
[*.{html,html.txt}]
indent_style = tab
tab_width = 2

# Set properties for XML files:
[*.{xml,xml.txt}]
indent_style = tab
tab_width = 2

# Set properties for CSS files:
[*.css]
[*.{css,css.txt}]
indent_style = tab

# Set properties for Makefiles:
[Makefile]
indent_style = tab

[*.mk]
[*.{mk,mk.txt}]
indent_style = tab

# Set properties for Markdown files:
[*.md]
[*.{md,md.txt}]
indent_style = space
indent_size = 4
trim_trailing_whitespace = false
Expand All @@ -112,7 +130,7 @@ indent_style = space
indent_size = 4

# Set properties for `package.json` files:
[package.json]
[package.{json,json.txt}]
indent_style = space
indent_size = 2

Expand All @@ -121,6 +139,11 @@ indent_size = 2
indent_style = space
indent_size = 2

# Set properties for `manifest.json` files:
[manifest.json]
indent_style = space
indent_size = 2

# Set properties for `tslint.json` files:
[tslint.json]
indent_style = space
Expand All @@ -132,15 +155,15 @@ indent_style = space
indent_size = 2

# Set properties for LaTeX files:
[*.tex]
[*.{tex,tex.txt}]
indent_style = tab

# Set properties for LaTeX Bibliography files:
[*.bib]
[*.{bib,bib.txt}]
indent_style = tab

# Set properties for YAML files:
[*.yml]
[*.{yml,yml.txt}]
indent_style = space
indent_size = 2

Expand Down
6 changes: 4 additions & 2 deletions .github/workflows/benchmark.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,14 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
- uses: actions/setup-node@v2
with:
node-version: 15
node-version: 'lts/*'
timeout-minutes: 5
- name: Install production and development dependencies
run: |
npm install || npm install || npm install
timeout-minutes: 15
- name: Run benchmarks
run: |
npm run benchmark
6 changes: 4 additions & 2 deletions .github/workflows/examples.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,14 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
- uses: actions/setup-node@v2
with:
node-version: 15
node-version: 'lts/*'
timeout-minutes: 5
- name: Install production and development dependencies
run: |
npm install || npm install || npm install
timeout-minutes: 15
- name: Run examples
run: |
npm run examples
23 changes: 13 additions & 10 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@
name: Publish Package

# Workflow triggers:
on: push
on:
push:
tags: v[0-9]+.[0-9]+.[0-9]+

# Workflow jobs:
jobs:
Expand All @@ -30,23 +32,24 @@ jobs:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
- uses: actions/setup-node@v2
with:
node-version: 15
- name: Increment version
node-version: 'lts/*'
timeout-minutes: 5
- name: Replace all GitHub links to individual packages with npm links
run: |
git config --local user.email "noreply@stdlib.io"
git config --local user.name "stdlib-bot"
npm version patch
find . -type f -name '*.md' -print0 | xargs -0 sed -Ei 's/@stdlib\/([^:]*)\]: https:\/\/github.com\/stdlib-js/@stdlib\/\1\]: https:\/\/www.npmjs.com\/package\/@stdlib/g'
- name: Replace all stdlib GitHub dependencies with the respective npm packages
run: |
find package.json -type f -print0 | xargs -0 sed -Ei 's/"github:stdlib-js[^"]*"/"^0.0.x"/g'
- name: Publish package to npm
uses: JS-DevTools/npm-publish@v1
with:
token: ${{ secrets.NPM_TOKEN }}
access: public
- name: Push changes
- name: Discard any uncommitted changes
run: |
git push origin main
git push --tags
git reset --hard
- uses: act10ns/slack@v1
with:
status: ${{ job.status }}
Expand Down
7 changes: 5 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ on:
# * is a special character in YAML so you have to quote this string
- cron: '30 1 * * 6'
workflow_dispatch:
push:

# Workflow jobs:
jobs:
Expand All @@ -34,13 +35,15 @@ jobs:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
- uses: actions/setup-node@v2
with:
node-version: 15
node-version: 'lts/*'
timeout-minutes: 5
- name: Install production and development dependencies
id: install
run: |
npm install || npm install || npm install
timeout-minutes: 15
- name: Run tests
id: tests
run: |
Expand Down
7 changes: 5 additions & 2 deletions .github/workflows/test_coverage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,18 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
- uses: actions/setup-node@v2
with:
node-version: 15
node-version: 'lts/*'
timeout-minutes: 5
- name: Install production and development dependencies
run: |
npm install || npm install || npm install
timeout-minutes: 15
- name: Calculate test coverage
run: |
npm run test-cov || npm run test-cov || npm run test-cov
timeout-minutes: 15
- name: Upload coverage to Codecov
id: upload
uses: codecov/codecov-action@v1
Expand Down
8 changes: 5 additions & 3 deletions .github/workflows/test_install.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,15 @@ jobs:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
if: ${{ github.event.workflow_run.conclusion == 'success' }}
steps:
- uses: actions/checkout@v1
- uses: actions/setup-node@v1
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 15
node-version: 'lts/*'
timeout-minutes: 5
- name: Install production dependencies via npm
run: |
npm install --only=prod || npm install --only=prod || npm install --only=prod
timeout-minutes: 15
- uses: act10ns/slack@v1
with:
status: ${{ job.status }}
Expand Down
5 changes: 1 addition & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

# Files #
#########
.postinstall.json
package.json.copy

# Directories #
###############
Expand Down Expand Up @@ -70,9 +70,6 @@ tmp/
*.tar
*.zip

# Make an exception for compressed distributable files:
!dist/*.gz

# Logs and databases #
######################
*.log
Expand Down
1 change: 1 addition & 0 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Makefile
**/examples/
reports/
support/
scripts/
**/tmp/
workshops/

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The [kurtosis][sample-excess-kurtosis] for a random variable `X` is defined as
<!-- <equation class="equation" label="eq:kurtosis" align="center" raw="\operatorname{Kurtosis}[X] = \mathrm{E}\biggl[ \biggl( \frac{X - \mu}{\sigma} \biggr)^4 \biggr]" alt="Equation for the kurtosis."> -->

<div class="equation" align="center" data-raw-text="\operatorname{Kurtosis}[X] = \mathrm{E}\biggl[ \biggl( \frac{X - \mu}{\sigma} \biggr)^4 \biggr]" data-equation="eq:kurtosis">
<img src="https://cdn.rawgit.com/stdlib-js/stdlib/27e2a43c70db648bb5bbc3fd0cdee050c25adc0b/lib/node_modules/@stdlib/stats/incr/kurtosis/docs/img/equation_kurtosis.svg" alt="Equation for the kurtosis.">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@49d8cabda84033d55d7b8069f19ee3dd8b8d1496/lib/node_modules/@stdlib/stats/incr/kurtosis/docs/img/equation_kurtosis.svg" alt="Equation for the kurtosis.">
<br>
</div>

Expand All @@ -44,7 +44,7 @@ For a sample of `n` values, the [sample excess kurtosis][sample-excess-kurtosis]
<!-- <equation class="equation" label="eq:sample_excess_kurtosis" align="center" raw="g_2 = \frac{m_4}{m_2^2} - 3 = \frac{\frac{1}{n} \sum_{i=0}^{n-1} (x_i - \bar{x})^4}{\biggl(\frac{1}{n} \sum_{i=0}^{n-1} (x_i - \bar{x})^2\biggr)^2}" alt="Equation for the sample excess kurtosis."> -->

<div class="equation" align="center" data-raw-text="g_2 = \frac{m_4}{m_2^2} - 3 = \frac{\frac{1}{n} \sum_{i=0}^{n-1} (x_i - \bar{x})^4}{\biggl(\frac{1}{n} \sum_{i=0}^{n-1} (x_i - \bar{x})^2\biggr)^2}" data-equation="eq:sample_excess_kurtosis">
<img src="https://cdn.rawgit.com/stdlib-js/stdlib/27e2a43c70db648bb5bbc3fd0cdee050c25adc0b/lib/node_modules/@stdlib/stats/incr/kurtosis/docs/img/equation_sample_excess_kurtosis.svg" alt="Equation for the sample excess kurtosis.">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@49d8cabda84033d55d7b8069f19ee3dd8b8d1496/lib/node_modules/@stdlib/stats/incr/kurtosis/docs/img/equation_sample_excess_kurtosis.svg" alt="Equation for the sample excess kurtosis.">
<br>
</div>

Expand All @@ -57,7 +57,7 @@ The previous equation is, however, a biased estimator of the population excess k
<!-- <equation class="equation" label="eq:corrected_sample_excess_kurtosis" align="center" raw="G_2 = \frac{(n+1)n}{(n-1)(n-2)(n-3)} \frac{\sum_{i=0}^{n-1} (x_i - \bar{x})^4}{\biggl(\sum_{i=0}^{n-1} (x_i - \bar{x})^2\biggr)^2} - 3 \frac{(n-1)^2}{(n-2)(n-3)}" alt="Equation for the corrected sample excess kurtosis."> -->

<div class="equation" align="center" data-raw-text="G_2 = \frac{(n+1)n}{(n-1)(n-2)(n-3)} \frac{\sum_{i=0}^{n-1} (x_i - \bar{x})^4}{\biggl(\sum_{i=0}^{n-1} (x_i - \bar{x})^2\biggr)^2} - 3 \frac{(n-1)^2}{(n-2)(n-3)}" data-equation="eq:corrected_sample_excess_kurtosis">
<img src="https://cdn.rawgit.com/stdlib-js/stdlib/27e2a43c70db648bb5bbc3fd0cdee050c25adc0b/lib/node_modules/@stdlib/stats/incr/kurtosis/docs/img/equation_corrected_sample_excess_kurtosis.svg" alt="Equation for the corrected sample excess kurtosis.">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@49d8cabda84033d55d7b8069f19ee3dd8b8d1496/lib/node_modules/@stdlib/stats/incr/kurtosis/docs/img/equation_corrected_sample_excess_kurtosis.svg" alt="Equation for the corrected sample excess kurtosis.">
<br>
</div>

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
],
"main": "./lib",
"directories": {
"benchmark": "./benchmark",
"doc": "./docs",
"example": "./examples",
"lib": "./lib",
Expand Down

0 comments on commit f77be38

Please sign in to comment.