Skip to content

Commit dd9fa96

Browse files
PlaneshifterPlaneshifter
committed
Rename package to avoid confusion with rank of a matrix
1 parent d46b75c commit dd9fa96

File tree

14 files changed

+53
-52
lines changed

14 files changed

+53
-52
lines changed

‎lib/node_modules/@stdlib/namespace/lib/namespace/r.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@
2727
var ns = [];
2828

2929
ns.push({
30-
'alias': 'rank',
31-
'path': '@stdlib/stats/rank',
32-
'value': require( '@stdlib/stats/rank' ),
30+
'alias': 'ranks',
31+
'path': '@stdlib/stats/ranks',
32+
'value': require( '@stdlib/stats/ranks' ),
3333
'type': 'Function',
3434
'related': []
3535
});

‎lib/node_modules/@stdlib/stats/lib/index.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,13 +91,13 @@ setReadOnly( ns, 'lowess', require( '@stdlib/stats/lowess' ) );
9191
setReadOnly( ns, 'pcorrtest', require( '@stdlib/stats/pcorrtest' ) );
9292

9393
/**
94-
* @name rank
94+
* @name ranks
9595
* @memberof ns
9696
* @readonly
9797
* @type {Function}
98-
* @see {@link module:@stdlib/stats/rank}
98+
* @see {@link module:@stdlib/stats/ranks}
9999
*/
100-
setReadOnly( ns, 'rank', require( '@stdlib/stats/rank' ) );
100+
setReadOnly( ns, 'ranks', require( '@stdlib/stats/ranks' ) );
101101

102102
/**
103103
* @name ttest

lib/node_modules/@stdlib/stats/rank/README.md renamed to lib/node_modules/@stdlib/stats/ranks/README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ limitations under the License.
1818
1919
-->
2020

21-
# rank
21+
# ranks
2222

2323
> Compute ranks for values of an array-like object.
2424
@@ -27,26 +27,26 @@ limitations under the License.
2727
## Usage
2828

2929
```javascript
30-
var rank = require( '@stdlib/stats/rank' );
30+
var ranks = require( '@stdlib/stats/ranks' );
3131
```
3232

33-
#### rank( arr\[, opts] )
33+
#### ranks( arr\[, opts] )
3434

3535
Returns the sample ranks of the elements in `arr`, which can be either an [`array`][mdn-array] or [`typed array`][mdn-typed-array].
3636

3737
```javascript
3838
var arr = [ 1.1, 2.0, 3.5, 0.0, 2.4 ];
39-
var out = rank( arr );
39+
var out = ranks( arr );
4040
// returns [ 2, 3, 5, 1, 4 ]
4141

4242
// Ties are averaged:
4343
arr = [ 2, 2, 1, 4, 3 ];
44-
out = rank( arr );
44+
out = ranks( arr );
4545
// returns [ 2.5, 2.5, 1, 5, 4 ];
4646

4747
// Missing values are placed last:
4848
arr = [ null, 2, 2, 1, 4, 3, NaN, NaN ];
49-
out = rank( arr );
49+
out = ranks( arr );
5050
// returns [ 6, 2.5, 2.5, 1, 5, 4, 7 ,8 ]
5151
```
5252

@@ -62,26 +62,26 @@ When all elements of the `array` are different, the ranks are uniquely determine
6262
var data = [ 2, 2, 1, 4, 3 ];
6363

6464
// Max method:
65-
var out = rank( data, {
65+
var out = ranks( data, {
6666
'method': 'max'
6767
});
6868
// returns [ 3, 3, 1, 5, 4 ]
6969

7070
// Min method:
71-
out = rank( data, {
71+
out = ranks( data, {
7272
'method': 'min'
7373
});
7474
// returns [ 2, 2, 1, 5, 4 ]
7575

7676
// Ordinal method
77-
out = rank( data, {
77+
out = ranks( data, {
7878
'method': 'ordinal'
7979
});
8080
// returns [ 2, 3, 1, 5, 4 ]
8181

8282
// Dense method:
8383
out = [ 2, 2, 1, 4, 3 ];
84-
out = rank( data, {
84+
out = ranks( data, {
8585
'method': 'dense'
8686
});
8787
// returns [ 2, 2, 1, 4, 3 ]
@@ -92,17 +92,17 @@ The `missing` option is used to specify how to handle missing data. By default,
9292
```javascript
9393
var data = [ NaN, 2, 2, 1, 4, 3, null, null ];
9494

95-
var out = rank( data, {
95+
var out = ranks( data, {
9696
'missing': 'first'
9797
});
9898
// returns [ 1, 5.5, 5.5, 4, 8, 7, 2, 3 ]
9999

100-
out = rank( data, {
100+
out = ranks( data, {
101101
'missing': 'last'
102102
});
103103
// returns [ 6, 2.5, 2.5, 1, 5, 4, 7 ,8 ]
104104

105-
out = rank( data, {
105+
out = ranks( data, {
106106
'missing': 'remove'
107107
});
108108
// returns [ 2.5, 2.5, 1, 5, 4 ]
@@ -115,7 +115,7 @@ var Int32Array = require( '@stdlib/array/int32' );
115115

116116
var data = new Int32Array( [ 2, 1, -999, 3, 4 ] );
117117

118-
var out = rank( data, {
118+
var out = ranks( data, {
119119
'encoding': [ -999 ]
120120
});
121121
// returns [ 2, 1, 5, 3, 4 ]
@@ -135,7 +135,7 @@ var out = rank( data, {
135135
var Int32Array = require( '@stdlib/array/int32' );
136136
var round = require( '@stdlib/math/base/special/round' );
137137
var randu = require( '@stdlib/random/base/randu' );
138-
var rank = require( '@stdlib/stats/rank' );
138+
var ranks = require( '@stdlib/stats/ranks' );
139139

140140
var data;
141141
var out;
@@ -147,7 +147,7 @@ for ( i = 0; i < data.length; i++ ) {
147147
data[ i ] = round( randu()*10.0 );
148148
}
149149

150-
out = rank( data );
150+
out = ranks( data );
151151
// returns <array>
152152

153153
// Typed arrays...
@@ -156,7 +156,7 @@ for ( i = 0; i < data.length; i++ ) {
156156
data[ i ] = randu() * 10.0;
157157
}
158158

159-
out = rank( data );
159+
out = ranks( data );
160160
// returns <array>
161161
```
162162

lib/node_modules/@stdlib/stats/rank/docs/repl.txt renamed to lib/node_modules/@stdlib/stats/ranks/docs/repl.txt

File renamed without changes.

lib/node_modules/@stdlib/stats/rank/examples/index.js renamed to lib/node_modules/@stdlib/stats/ranks/examples/index.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
var Int32Array = require( '@stdlib/array/int32' );
2222
var round = require( '@stdlib/math/base/special/round' );
2323
var randu = require( '@stdlib/random/base/randu' );
24-
var rank = require( './../lib' );
24+
var ranks = require( './../lib' );
2525

2626
var data;
2727
var out;
@@ -33,7 +33,7 @@ for ( i = 0; i < data.length; i++ ) {
3333
data[ i ] = round( randu()*10.0 );
3434
}
3535

36-
out = rank( data );
36+
out = ranks( data );
3737
console.log( 'data: [ %s ]', data.join( ', ' ) );
3838
console.log( 'ranks: [ %s ]', out.join( ', ' ) );
3939

@@ -43,6 +43,6 @@ for ( i = 0; i < data.length; i++ ) {
4343
data[ i ] = randu() * 10.0;
4444
}
4545

46-
out = rank( data );
46+
out = ranks( data );
4747
console.log( 'data: [ %s ]', data.join( ', ' ) );
4848
console.log( 'ranks: [ %s ]', out.join( ', ' ) );

lib/node_modules/@stdlib/stats/rank/lib/index.js renamed to lib/node_modules/@stdlib/stats/ranks/lib/index.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,31 +21,31 @@
2121
/**
2222
* Compute ranks for the values of an array-like object.
2323
*
24-
* @module @stdlib/stats/rank
24+
* @module @stdlib/stats/ranks
2525
*
2626
* @example
27-
* var rank = require( '@stdlib/stats/rank' );
27+
* var ranks = require( '@stdlib/stats/ranks' );
2828
*
2929
* var arr = [ 1.1, 2.0, 3.5, 0.0, 2.4 ];
30-
* var out = rank( arr );
30+
* var out = ranks( arr );
3131
* // returns [ 2, 3, 5, 1, 4 ]
3232
*
3333
* // Ties are averaged:
3434
* arr = [ 2, 2, 1, 4, 3 ];
35-
* out = rank ( arr );
35+
* out = ranks ( arr );
3636
* // returns [ 2.5, 2.5, 1, 5, 4 ];
3737
*
3838
* // Missing values are placed last:
3939
* arr = [ null, 2, 2, 1, 4, 3, NaN, NaN ];
40-
* out = rank( arr );
40+
* out = ranks( arr );
4141
* // returns [ 6, 2.5, 2.5, 1, 5, 4, 7 ,8 ]
4242
*/
4343

4444
// MODULES //
4545

46-
var rank = require( './main.js' );
46+
var ranks = require( './main.js' );
4747

4848

4949
// EXPORTS //
5050

51-
module.exports = rank;
51+
module.exports = ranks;

lib/node_modules/@stdlib/stats/rank/lib/is_missing.js renamed to lib/node_modules/@stdlib/stats/ranks/lib/is_missing.js

File renamed without changes.

lib/node_modules/@stdlib/stats/rank/lib/main.js renamed to lib/node_modules/@stdlib/stats/ranks/lib/main.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,22 +41,22 @@ var validate = require( './validate.js' );
4141
*
4242
* @example
4343
* var arr = [ 1.1, 2.0, 3.5, 0.0, 2.4 ];
44-
* var out = rank( arr );
44+
* var out = ranks( arr );
4545
* // returns [ 2, 3, 5, 1, 4 ]
4646
*
4747
* @example
4848
* // Ties are averaged:
4949
* arr = [ 2, 2, 1, 4, 3 ];
50-
* out = rank ( arr );
50+
* out = ranks( arr );
5151
* // returns [ 2.5, 2.5, 1, 5, 4 ];
5252
*
5353
* @example
5454
* // Missing values are placed last:
5555
* arr = [ null, 2, 2, 1, 4, 3, NaN, NaN ];
56-
* out = rank( arr );
56+
* out = ranks( arr );
5757
* // returns [ 6, 2.5, 2.5, 1, 5, 4, 7 ,8 ]
5858
*/
59-
function rank( x, options ) {
59+
function ranks( x, options ) {
6060
var missingIndices;
6161
var noDuplicates;
6262
var countMissing;
@@ -170,4 +170,4 @@ function rank( x, options ) {
170170

171171
// EXPORTS //
172172

173-
module.exports = rank;
173+
module.exports = ranks;

lib/node_modules/@stdlib/stats/rank/lib/order.js renamed to lib/node_modules/@stdlib/stats/ranks/lib/order.js

File renamed without changes.

lib/node_modules/@stdlib/stats/rank/lib/sum.js renamed to lib/node_modules/@stdlib/stats/ranks/lib/sum.js

File renamed without changes.

0 commit comments

Comments
 (0)