Data

Tools

Indexes

Applications

Experiments

Open Source Science

stats-ranks

Compute ranks for values of an array-like object.

https://github.com/stdlib-js/stats-ranks

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.3%) to scientific vocabulary

Keywords

javascript math mathematics missing node node-js nodejs order ordered rank ranks statistics stats stdlib
Last synced: 6 months ago · JSON representation ·

Repository

Compute ranks for values of an array-like object.

Basic Info
Statistics
  • Stars: 2
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
javascript math mathematics missing node node-js nodejs order ordered rank ranks statistics stats stdlib
Created over 4 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

ranks

NPM version Build Status Coverage Status <!-- dependencies -->

Compute ranks for values of an array-like object.

## Installation ```bash npm install @stdlib/stats-ranks ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage ```javascript var ranks = require( '@stdlib/stats-ranks' ); ``` #### ranks( arr\[, opts] ) Returns the sample ranks of the elements in `arr`, which can be either an [`array`][mdn-array] or [`typed array`][mdn-typed-array]. ```javascript var arr = [ 1.1, 2.0, 3.5, 0.0, 2.4 ]; var out = ranks( arr ); // returns [ 2, 3, 5, 1, 4 ] // Ties are averaged: arr = [ 2, 2, 1, 4, 3 ]; out = ranks( arr ); // returns [ 2.5, 2.5, 1, 5, 4 ]; // Missing values are placed last: arr = [ null, 2, 2, 1, 4, 3, NaN, NaN ]; out = ranks( arr ); // returns [ 6, 2.5, 2.5, 1, 5, 4, 7, 8 ] ``` The function accepts the following options: - **method**: `string` indicating how ties are handled. Can be one of the following values: `'average'`, `'min'`, `'max'`, `'ordinal'` and `'dense'`. Default: `'average'`. - **missing**: `string` specifying how missing values are handled. Must be either `'last'`, `'first'` or `'remove'`. Default: `'last'`. - **encoding**: `array` holding all values which will be regarded as missing values. Default: `[ NaN, null]`. When all elements of the `array` are different, the ranks are uniquely determined. When there are equal elements (called _ties_), the `method` option determines how they are handled. The default, `'average'`, replace the ranks of the ties by their mean. Other possible options are `'min'` and `'max'`, which replace the ranks of the ties by their minimum and maximum, respectively. `'dense'` works like `'min'`, with the difference that the next highest element after a tie is assigned the next smallest integer. Finally, `ordinal` gives each element in `arr` a distinct rank, according to the position they appear in. ```javascript var data = [ 2, 2, 1, 4, 3 ]; // Max method: var out = ranks( data, { 'method': 'max' }); // returns [ 3, 3, 1, 5, 4 ] // Min method: out = ranks( data, { 'method': 'min' }); // returns [ 2, 2, 1, 5, 4 ] // Ordinal method out = ranks( data, { 'method': 'ordinal' }); // returns [ 2, 3, 1, 5, 4 ] // Dense method: out = [ 2, 2, 1, 4, 3 ]; out = ranks( data, { 'method': 'dense' }); // returns [ 2, 2, 1, 4, 3 ] ``` The `missing` option is used to specify how to handle missing data. By default, `NaN` or `null` are treated as missing values. `'last'`specifies that missing values are placed last, `'first'` that the are assigned the lowest ranks and `'remove'` means that they are removed from the array before the ranks are calculated. ```javascript var data = [ NaN, 2, 2, 1, 4, 3, null, null ]; var out = ranks( data, { 'missing': 'first' }); // returns [ 1, 5.5, 5.5, 4, 8, 7, 2, 3 ] out = ranks( data, { 'missing': 'last' }); // returns [ 6, 2.5, 2.5, 1, 5, 4, 7, 8 ] out = ranks( data, { 'missing': 'remove' }); // returns [ 2.5, 2.5, 1, 5, 4 ] ``` Custom encoding for missing values is supported via the `encoding` option, which allows to supply the function with an `array` of values which should be treated as missing. ```javascript var Int32Array = require( '@stdlib/array-int32' ); var data = new Int32Array( [ 2, 1, -999, 3, 4 ] ); var out = ranks( data, { 'encoding': [ -999 ] }); // returns [ 2, 1, 5, 3, 4 ] ```
## Examples ```javascript var Int32Array = require( '@stdlib/array-int32' ); var round = require( '@stdlib/math-base-special-round' ); var randu = require( '@stdlib/random-base-randu' ); var ranks = require( '@stdlib/stats-ranks' ); var data; var out; var i; // Plain arrays... data = []; for ( i = 0; i < data.length; i++ ) { data.push( round( randu()*10.0 ) ); } out = ranks( data ); // returns // Typed arrays... data = new Int32Array( 10 ); for ( i = 0; i < data.length; i++ ) { data[ i ] = randu() * 10.0; } out = ranks( data ); // returns ```
* * * ## Notice This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

  • Name: stdlib
  • Login: stdlib-js
  • Kind: organization

Standard library for JavaScript.

Citation (CITATION.cff) 

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total
  • Push event: 24
Last Year
  • Push event: 24

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 67
  • Total Committers: 1
  • Avg Commits per committer: 67.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 9
  • Committers: 1
  • Avg Commits per committer: 9.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
stdlib-bot n****y@s****o 67
Committer Domains (Top 20 + Academic)
stdlib.io: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

package.json npm
  • @stdlib/array-int32 ^0.0.x development
  • @stdlib/bench ^0.0.x development
  • @stdlib/math-base-special-round ^0.0.x development
  • @stdlib/random-base-randu ^0.0.x development
  • istanbul ^0.4.1 development
  • tap-spec 5.x.x development
  • tape git+https://github.com/kgryte/tape.git#fix/globby development
  • @stdlib/assert-contains ^0.0.x
  • @stdlib/assert-has-own-property ^0.0.x
  • @stdlib/assert-is-array ^0.0.x
  • @stdlib/assert-is-collection ^0.0.x
  • @stdlib/assert-is-object ^0.0.x
  • @stdlib/assert-is-string ^0.0.x
  • @stdlib/string-format ^0.0.x
  • @stdlib/types ^0.0.x
.github/workflows/benchmark.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/cancel.yml actions
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/close_pull_requests.yml actions
  • superbrothers/close-pull-request v3 composite
.github/workflows/examples.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/npm_downloads.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • actions/upload-artifact v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/productionize.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • stdlib-js/bundle-action main composite
  • stdlib-js/transform-errors-action main composite
.github/workflows/publish.yml actions
  • JS-DevTools/npm-publish v1 composite
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/test.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/test_bundles.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • denoland/setup-deno v1 composite
.github/workflows/test_coverage.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • codecov/codecov-action v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/test_install.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite