npm install @stdlib/stats-ranks

Alternatively,

• To load the package in a website via ascript tag without installation and bundlers, use theES Module available on theesm branch (seeREADME).
• If you are using Deno, visit thedeno branch (seeREADME for usage intructions).
• For use in Observable, or in browser/node environments, use theUniversal Module Definition (UMD) build available on theumd branch (seeREADME).

Thebranches.md 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.

varranks=require('@stdlib/stats-ranks');

Returns the sample ranks of the elements inarr, which can be either anarray ortyped array.

vararr=[1.1,2.0,3.5,0.0,2.4];varout=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 thearray are different, the ranks are uniquely determined. When there are equal elements (calledties), themethod 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 inarr a distinct rank, according to the position they appear in.

vardata=[2,2,1,4,3];// Max method:varout=ranks(data,{'method':'max'});// returns [ 3, 3, 1, 5, 4 ]// Min method:out=ranks(data,{'method':'min'});// returns [ 2, 2, 1, 5, 4 ]// Ordinal methodout=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 ]

Themissing option is used to specify how to handle missing data. By default,NaN ornull 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.

vardata=[NaN,2,2,1,4,3,null,null];varout=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 theencoding option, which allows to supply the function with anarray of values which should be treated as missing.

varInt32Array=require('@stdlib/array-int32');vardata=newInt32Array([2,1,-999,3,4]);varout=ranks(data,{'encoding':[-999]});// returns [ 2, 1, 5, 3, 4 ]

This package is part ofstdlib, 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 developstdlib, see the main projectrepository.

SeeLICENSE.

Copyright © 2016-2024. The StdlibAuthors.