-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
208 lines (183 loc) · 4.5 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
/*
* @license Apache-2.0
*
* Copyright (c) 2021 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// TypeScript Version: 2.0
/// <reference types="@stdlib/types"/>
import { NumericArray } from '@stdlib/types/array';
/**
* Interface defining function options.
*/
interface Options {
/**
* Significance level (default: 0.05).
*/
alpha?: number;
/**
* Alternative hypothesis (`two-sided`, `less`, or `greater`; default: 'two-sided').
*/
alternative?: 'two-sided' | 'less' | 'greater';
/**
* Mean under `H0` (default: 0).
*/
mu?: number;
}
/**
* Test result.
*/
interface Results {
/**
* Used significance level.
*/
alpha: number;
/**
* Test decision.
*/
rejected: boolean;
/**
* p-value of the test.
*/
pValue: number;
/**
* Value of test statistic.
*/
statistic: number;
/**
* 1-alpha confidence interval for the mean.
*/
ci: Array<number>;
/**
* Assumed mean under H0 (or difference in means when `y` is supplied).
*/
nullValue: number;
/**
* Alternative hypothesis (`two-sided`, `less` or `greater`).
*/
alternative: string;
/**
* Degrees of freedom.
*/
df: number;
/**
* Sample mean of `x` or `x - y`, respectively.
*/
mean: number;
/**
* Standard error of the mean.
*/
sd: number;
/**
* Name of test.
*/
method: string;
/**
* Function to print formatted output.
*/
print: Function;
}
/**
* Interface for Student's t test.
*/
interface TTest {
/**
* Computes a paired Student's t test.
*
* @param x - input array
* @param y - optional paired array
* @param options - function options
* @param options.alpha - significance level (default: 0.05)
* @param options.alternative - alternative hypothesis (`two-sided`, `less`, or `greater`; default: 'two-sided')
* @param options.mu - mean under `H0` (default: 0)
* @throws first argument must have at least two elements
* @throws paired array must have the same length as the first argument
* @throws must provide valid options
* @returns test results
*
* @example
* var x = [ 4.0, 4.0, 6.0, 6.0, 5.0 ];
* var y = [ 5.0, 5.0, 5.5, 7.0, 5.8 ];
* var opts = {
* 'alpha': 0.1
* };
* var out = ttest( x, opts );
* // returns {...}
*/
( x: NumericArray, y: NumericArray, options?: Options ): Results;
/**
* Computes a one-sample Student's t test.
*
* @param x - input array
* @param options - function options
* @param options.alpha - significance level (default: 0.05)
* @param options.alternative - alternative hypothesis (`two-sided`, `less`, or `greater`; default: 'two-sided')
* @param options.mu - mean under `H0` (default: 0)
* @throws first argument must have at least two elements
* @throws must provide valid options
* @returns test results
*
* @example
* var x = [ 4.0, 4.0, 6.0, 6.0, 5.0 ];
* var opts = {
* 'mu': 5.0
* };
* var out = ttest( x, opts );
* // returns {...}
*
* @example
* var x = [ 4.0, 4.0, 6.0, 6.0, 5.0 ];
* var opts = {
* 'alternative': 'greater'
* };
* var out = ttest( x, opts );
* // returns {...}
*/
( x: NumericArray, options?: Options ): Results;
}
/**
* Computes a one-sample or paired Student's t test.
*
* @param x - input array
* @param y - optional paired array
* @param options - function options
* @param options.alpha - significance level (default: 0.05)
* @param options.alternative - alternative hypothesis (`two-sided`, `less`, or `greater`; default: 'two-sided')
* @param options.mu - mean under `H0` (default: 0)
* @throws first argument must have at least two elements
* @throws paired array must have the same length as the first argument
* @throws second argument must be either a numeric array or an options object
* @throws must provide valid options
* @returns test results
*
* @example
* var x = [ 4.0, 4.0, 6.0, 6.0, 5.0 ];
* var opts = {
* 'mu': 5.0
* };
* var out = ttest( x, opts );
* // returns {...}
*
* @example
* var x = [ 4.0, 4.0, 6.0, 6.0, 5.0 ];
* var y = [ 5.0, 5.0, 5.5, 7.0, 5.8 ];
* var opts = {
* 'alpha': 0.1
* };
* var out = ttest( x, opts );
* // returns {...}
*/
declare var ttest: TTest;
// EXPORTS //
export = ttest;