sqa 0.0.37 → 0.0.38

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +62 -0
  3. data/docs/api-reference/alphavantageapi.md +105 -105
  4. data/docs/api-reference/apierror.md +2 -2
  5. data/docs/api-reference/index.md +2 -2
  6. data/docs/api-reference/notimplemented.md +2 -2
  7. data/docs/api-reference/sqa.md +12 -12
  8. data/docs/api-reference/sqa_backtest.md +43 -9
  9. data/docs/api-reference/sqa_backtest_results.md +34 -34
  10. data/docs/api-reference/sqa_badparametererror.md +1 -1
  11. data/docs/api-reference/sqa_config.md +31 -31
  12. data/docs/api-reference/sqa_configurationerror.md +1 -1
  13. data/docs/api-reference/sqa_datafetcherror.md +3 -3
  14. data/docs/api-reference/sqa_dataframe.md +63 -36
  15. data/docs/api-reference/sqa_dataframe_alphavantage.md +2 -2
  16. data/docs/api-reference/sqa_dataframe_data.md +18 -18
  17. data/docs/api-reference/sqa_dataframe_yahoofinance.md +2 -2
  18. data/docs/api-reference/sqa_ensemble.md +21 -21
  19. data/docs/api-reference/sqa_fpop.md +8 -8
  20. data/docs/api-reference/sqa_geneticprogram.md +20 -20
  21. data/docs/api-reference/sqa_geneticprogram_individual.md +8 -8
  22. data/docs/api-reference/sqa_marketregime.md +10 -10
  23. data/docs/api-reference/sqa_multitimeframe.md +11 -11
  24. data/docs/api-reference/sqa_patternmatcher.md +9 -9
  25. data/docs/api-reference/sqa_pluginmanager.md +4 -4
  26. data/docs/api-reference/sqa_portfolio.md +84 -27
  27. data/docs/api-reference/sqa_portfolio_position.md +12 -12
  28. data/docs/api-reference/sqa_portfolio_trade.md +16 -16
  29. data/docs/api-reference/sqa_portfoliooptimizer.md +10 -10
  30. data/docs/api-reference/sqa_riskmanager.md +12 -12
  31. data/docs/api-reference/sqa_seasonalanalyzer.md +6 -6
  32. data/docs/api-reference/sqa_sectoranalyzer.md +9 -9
  33. data/docs/api-reference/sqa_stock.md +48 -36
  34. data/docs/api-reference/sqa_strategy.md +8 -8
  35. data/docs/api-reference/sqa_strategy_bollingerbands.md +2 -2
  36. data/docs/api-reference/sqa_strategy_common.md +3 -3
  37. data/docs/api-reference/sqa_strategy_consensus.md +12 -12
  38. data/docs/api-reference/sqa_strategy_ema.md +4 -4
  39. data/docs/api-reference/sqa_strategy_kbs.md +11 -11
  40. data/docs/api-reference/sqa_strategy_macd.md +2 -2
  41. data/docs/api-reference/sqa_strategy_mp.md +4 -4
  42. data/docs/api-reference/sqa_strategy_mr.md +4 -4
  43. data/docs/api-reference/sqa_strategy_random.md +4 -4
  44. data/docs/api-reference/sqa_strategy_rsi.md +4 -4
  45. data/docs/api-reference/sqa_strategy_sma.md +4 -4
  46. data/docs/api-reference/sqa_strategy_stochastic.md +2 -2
  47. data/docs/api-reference/sqa_strategy_volumebreakout.md +2 -2
  48. data/docs/api-reference/sqa_strategygenerator.md +19 -19
  49. data/docs/api-reference/sqa_strategygenerator_pattern.md +17 -17
  50. data/docs/api-reference/sqa_strategygenerator_patterncontext.md +21 -21
  51. data/docs/api-reference/sqa_strategygenerator_profitablepoint.md +27 -27
  52. data/docs/api-reference/sqa_stream.md +18 -18
  53. data/docs/api-reference/sqa_ticker.md +8 -8
  54. data/docs/api-reference/string.md +11 -11
  55. data/docs/file_formats.md +250 -0
  56. data/lib/sqa/backtest.rb +32 -0
  57. data/lib/sqa/data_frame.rb +25 -0
  58. data/lib/sqa/portfolio.rb +54 -0
  59. data/lib/sqa/stock.rb +11 -0
  60. data/lib/sqa/version.rb +1 -1
  61. data/mkdocs.yml +1 -0
  62. metadata +2 -2
  63. data/docs/IMPROVEMENT_PLAN.md +0 -531
data/docs/api-reference/sqa_strategygenerator_patterncontext.md CHANGED
@@ -4,7 +4,7 @@
4
4
  Pattern Context - metadata about when/where pattern is valid
5
5
 
6
6
  !!! abstract "Source Information"
7
- **Defined in:** `lib/sqa/strategy_generator.rb:91`
7
+ **Defined in:** [`lib/sqa/strategy_generator.rb:91`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L91)
8
8
 
9
9
  **Inherits from:** `Object`
10
10
 
@@ -18,7 +18,7 @@ Returns the value of attribute market_regime.
18
18
 
19
19
 
20
20
  ??? info "Source Location"
21
- `lib/sqa/strategy_generator.rb:92`
21
+ [`lib/sqa/strategy_generator.rb:92`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L92)
22
22
 
23
23
  ---
24
24
 
@@ -34,7 +34,7 @@ Sets the attribute market_regime
34
34
 
35
35
 
36
36
  ??? info "Source Location"
37
- `lib/sqa/strategy_generator.rb:92`
37
+ [`lib/sqa/strategy_generator.rb:92`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L92)
38
38
 
39
39
  ---
40
40
 
@@ -46,7 +46,7 @@ Returns the value of attribute valid_months.
46
46
 
47
47
 
48
48
  ??? info "Source Location"
49
- `lib/sqa/strategy_generator.rb:92`
49
+ [`lib/sqa/strategy_generator.rb:92`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L92)
50
50
 
51
51
  ---
52
52
 
@@ -62,7 +62,7 @@ Sets the attribute valid_months
62
62
 
63
63
 
64
64
  ??? info "Source Location"
65
- `lib/sqa/strategy_generator.rb:92`
65
+ [`lib/sqa/strategy_generator.rb:92`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L92)
66
66
 
67
67
  ---
68
68
 
@@ -74,7 +74,7 @@ Returns the value of attribute valid_quarters.
74
74
 
75
75
 
76
76
  ??? info "Source Location"
77
- `lib/sqa/strategy_generator.rb:92`
77
+ [`lib/sqa/strategy_generator.rb:92`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L92)
78
78
 
79
79
  ---
80
80
 
@@ -90,7 +90,7 @@ Sets the attribute valid_quarters
90
90
 
91
91
 
92
92
  ??? info "Source Location"
93
- `lib/sqa/strategy_generator.rb:92`
93
+ [`lib/sqa/strategy_generator.rb:92`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L92)
94
94
 
95
95
  ---
96
96
 
@@ -102,7 +102,7 @@ Returns the value of attribute discovered_period.
102
102
 
103
103
 
104
104
  ??? info "Source Location"
105
- `lib/sqa/strategy_generator.rb:92`
105
+ [`lib/sqa/strategy_generator.rb:92`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L92)
106
106
 
107
107
  ---
108
108
 
@@ -118,7 +118,7 @@ Sets the attribute discovered_period
118
118
 
119
119
 
120
120
  ??? info "Source Location"
121
- `lib/sqa/strategy_generator.rb:92`
121
+ [`lib/sqa/strategy_generator.rb:92`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L92)
122
122
 
123
123
  ---
124
124
 
@@ -130,7 +130,7 @@ Returns the value of attribute validation_period.
130
130
 
131
131
 
132
132
  ??? info "Source Location"
133
- `lib/sqa/strategy_generator.rb:92`
133
+ [`lib/sqa/strategy_generator.rb:92`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L92)
134
134
 
135
135
  ---
136
136
 
@@ -146,7 +146,7 @@ Sets the attribute validation_period
146
146
 
147
147
 
148
148
  ??? info "Source Location"
149
- `lib/sqa/strategy_generator.rb:92`
149
+ [`lib/sqa/strategy_generator.rb:92`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L92)
150
150
 
151
151
  ---
152
152
 
@@ -158,7 +158,7 @@ Returns the value of attribute stability_score.
158
158
 
159
159
 
160
160
  ??? info "Source Location"
161
- `lib/sqa/strategy_generator.rb:92`
161
+ [`lib/sqa/strategy_generator.rb:92`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L92)
162
162
 
163
163
  ---
164
164
 
@@ -174,7 +174,7 @@ Sets the attribute stability_score
174
174
 
175
175
 
176
176
  ??? info "Source Location"
177
- `lib/sqa/strategy_generator.rb:92`
177
+ [`lib/sqa/strategy_generator.rb:92`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L92)
178
178
 
179
179
  ---
180
180
 
@@ -186,7 +186,7 @@ Returns the value of attribute sector.
186
186
 
187
187
 
188
188
  ??? info "Source Location"
189
- `lib/sqa/strategy_generator.rb:92`
189
+ [`lib/sqa/strategy_generator.rb:92`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L92)
190
190
 
191
191
  ---
192
192
 
@@ -202,7 +202,7 @@ Sets the attribute sector
202
202
 
203
203
 
204
204
  ??? info "Source Location"
205
- `lib/sqa/strategy_generator.rb:92`
205
+ [`lib/sqa/strategy_generator.rb:92`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L92)
206
206
 
207
207
  ---
208
208
 
@@ -214,7 +214,7 @@ Returns the value of attribute volatility_regime.
214
214
 
215
215
 
216
216
  ??? info "Source Location"
217
- `lib/sqa/strategy_generator.rb:92`
217
+ [`lib/sqa/strategy_generator.rb:92`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L92)
218
218
 
219
219
  ---
220
220
 
@@ -230,7 +230,7 @@ Sets the attribute volatility_regime
230
230
 
231
231
 
232
232
  ??? info "Source Location"
233
- `lib/sqa/strategy_generator.rb:92`
233
+ [`lib/sqa/strategy_generator.rb:92`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L92)
234
234
 
235
235
  ---
236
236
 
@@ -246,7 +246,7 @@ Sets the attribute volatility_regime
246
246
  a new instance of PatternContext
247
247
 
248
248
  ??? info "Source Location"
249
- `lib/sqa/strategy_generator.rb:96`
249
+ [`lib/sqa/strategy_generator.rb:96`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L96)
250
250
 
251
251
  ---
252
252
 
@@ -260,7 +260,7 @@ Sets the attribute volatility_regime
260
260
 
261
261
 
262
262
  ??? info "Source Location"
263
- `lib/sqa/strategy_generator.rb:107`
263
+ [`lib/sqa/strategy_generator.rb:107`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L107)
264
264
 
265
265
  ---
266
266
 
@@ -270,7 +270,7 @@ Sets the attribute volatility_regime
270
270
 
271
271
 
272
272
  ??? info "Source Location"
273
- `lib/sqa/strategy_generator.rb:111`
273
+ [`lib/sqa/strategy_generator.rb:111`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L111)
274
274
 
275
275
  ---
276
276
 
@@ -286,7 +286,7 @@ Check if pattern is valid for given date and conditions
286
286
 
287
287
 
288
288
  ??? info "Source Location"
289
- `lib/sqa/strategy_generator.rb:121`
289
+ [`lib/sqa/strategy_generator.rb:121`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L121)
290
290
 
291
291
  ---
292
292
 
data/docs/api-reference/sqa_strategygenerator_profitablepoint.md CHANGED
@@ -4,7 +4,7 @@
4
4
  Represents a profitable trade opportunity discovered in historical data
5
5
 
6
6
  !!! abstract "Source Information"
7
- **Defined in:** `lib/sqa/strategy_generator.rb:38`
7
+ **Defined in:** [`lib/sqa/strategy_generator.rb:38`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L38)
8
8
 
9
9
  **Inherits from:** `Object`
10
10
 
@@ -18,7 +18,7 @@ Returns the value of attribute entry_index.
18
18
 
19
19
 
20
20
  ??? info "Source Location"
21
- `lib/sqa/strategy_generator.rb:39`
21
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
22
22
 
23
23
  ---
24
24
 
@@ -34,7 +34,7 @@ Sets the attribute entry_index
34
34
 
35
35
 
36
36
  ??? info "Source Location"
37
- `lib/sqa/strategy_generator.rb:39`
37
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
38
38
 
39
39
  ---
40
40
 
@@ -46,7 +46,7 @@ Returns the value of attribute entry_price.
46
46
 
47
47
 
48
48
  ??? info "Source Location"
49
- `lib/sqa/strategy_generator.rb:39`
49
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
50
50
 
51
51
  ---
52
52
 
@@ -62,7 +62,7 @@ Sets the attribute entry_price
62
62
 
63
63
 
64
64
  ??? info "Source Location"
65
- `lib/sqa/strategy_generator.rb:39`
65
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
66
66
 
67
67
  ---
68
68
 
@@ -74,7 +74,7 @@ Returns the value of attribute exit_index.
74
74
 
75
75
 
76
76
  ??? info "Source Location"
77
- `lib/sqa/strategy_generator.rb:39`
77
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
78
78
 
79
79
  ---
80
80
 
@@ -90,7 +90,7 @@ Sets the attribute exit_index
90
90
 
91
91
 
92
92
  ??? info "Source Location"
93
- `lib/sqa/strategy_generator.rb:39`
93
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
94
94
 
95
95
  ---
96
96
 
@@ -102,7 +102,7 @@ Returns the value of attribute exit_price.
102
102
 
103
103
 
104
104
  ??? info "Source Location"
105
- `lib/sqa/strategy_generator.rb:39`
105
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
106
106
 
107
107
  ---
108
108
 
@@ -118,7 +118,7 @@ Sets the attribute exit_price
118
118
 
119
119
 
120
120
  ??? info "Source Location"
121
- `lib/sqa/strategy_generator.rb:39`
121
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
122
122
 
123
123
  ---
124
124
 
@@ -130,7 +130,7 @@ Returns the value of attribute gain_percent.
130
130
 
131
131
 
132
132
  ??? info "Source Location"
133
- `lib/sqa/strategy_generator.rb:39`
133
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
134
134
 
135
135
  ---
136
136
 
@@ -146,7 +146,7 @@ Sets the attribute gain_percent
146
146
 
147
147
 
148
148
  ??? info "Source Location"
149
- `lib/sqa/strategy_generator.rb:39`
149
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
150
150
 
151
151
  ---
152
152
 
@@ -158,7 +158,7 @@ Returns the value of attribute holding_days.
158
158
 
159
159
 
160
160
  ??? info "Source Location"
161
- `lib/sqa/strategy_generator.rb:39`
161
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
162
162
 
163
163
  ---
164
164
 
@@ -174,7 +174,7 @@ Sets the attribute holding_days
174
174
 
175
175
 
176
176
  ??? info "Source Location"
177
- `lib/sqa/strategy_generator.rb:39`
177
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
178
178
 
179
179
  ---
180
180
 
@@ -186,7 +186,7 @@ Returns the value of attribute indicators.
186
186
 
187
187
 
188
188
  ??? info "Source Location"
189
- `lib/sqa/strategy_generator.rb:39`
189
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
190
190
 
191
191
  ---
192
192
 
@@ -202,7 +202,7 @@ Sets the attribute indicators
202
202
 
203
203
 
204
204
  ??? info "Source Location"
205
- `lib/sqa/strategy_generator.rb:39`
205
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
206
206
 
207
207
  ---
208
208
 
@@ -214,7 +214,7 @@ Returns the value of attribute fpl_min_delta.
214
214
 
215
215
 
216
216
  ??? info "Source Location"
217
- `lib/sqa/strategy_generator.rb:39`
217
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
218
218
 
219
219
  ---
220
220
 
@@ -230,7 +230,7 @@ Sets the attribute fpl_min_delta
230
230
 
231
231
 
232
232
  ??? info "Source Location"
233
- `lib/sqa/strategy_generator.rb:39`
233
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
234
234
 
235
235
  ---
236
236
 
@@ -242,7 +242,7 @@ Returns the value of attribute fpl_max_delta.
242
242
 
243
243
 
244
244
  ??? info "Source Location"
245
- `lib/sqa/strategy_generator.rb:39`
245
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
246
246
 
247
247
  ---
248
248
 
@@ -258,7 +258,7 @@ Sets the attribute fpl_max_delta
258
258
 
259
259
 
260
260
  ??? info "Source Location"
261
- `lib/sqa/strategy_generator.rb:39`
261
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
262
262
 
263
263
  ---
264
264
 
@@ -270,7 +270,7 @@ Returns the value of attribute fpl_risk.
270
270
 
271
271
 
272
272
  ??? info "Source Location"
273
- `lib/sqa/strategy_generator.rb:39`
273
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
274
274
 
275
275
  ---
276
276
 
@@ -286,7 +286,7 @@ Sets the attribute fpl_risk
286
286
 
287
287
 
288
288
  ??? info "Source Location"
289
- `lib/sqa/strategy_generator.rb:39`
289
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
290
290
 
291
291
  ---
292
292
 
@@ -298,7 +298,7 @@ Returns the value of attribute fpl_direction.
298
298
 
299
299
 
300
300
  ??? info "Source Location"
301
- `lib/sqa/strategy_generator.rb:39`
301
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
302
302
 
303
303
  ---
304
304
 
@@ -314,7 +314,7 @@ Sets the attribute fpl_direction
314
314
 
315
315
 
316
316
  ??? info "Source Location"
317
- `lib/sqa/strategy_generator.rb:39`
317
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
318
318
 
319
319
  ---
320
320
 
@@ -326,7 +326,7 @@ Returns the value of attribute fpl_magnitude.
326
326
 
327
327
 
328
328
  ??? info "Source Location"
329
- `lib/sqa/strategy_generator.rb:39`
329
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
330
330
 
331
331
  ---
332
332
 
@@ -342,7 +342,7 @@ Sets the attribute fpl_magnitude
342
342
 
343
343
 
344
344
  ??? info "Source Location"
345
- `lib/sqa/strategy_generator.rb:39`
345
+ [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
346
346
 
347
347
  ---
348
348
 
@@ -358,7 +358,7 @@ Sets the attribute fpl_magnitude
358
358
  a new instance of ProfitablePoint
359
359
 
360
360
  ??? info "Source Location"
361
- `lib/sqa/strategy_generator.rb:43`
361
+ [`lib/sqa/strategy_generator.rb:43`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L43)
362
362
 
363
363
  ---
364
364
 
@@ -368,7 +368,7 @@ Sets the attribute fpl_magnitude
368
368
 
369
369
 
370
370
  ??? info "Source Location"
371
- `lib/sqa/strategy_generator.rb:62`
371
+ [`lib/sqa/strategy_generator.rb:62`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L62)
372
372
 
373
373
  ---
374
374
 
data/docs/api-reference/sqa_stream.md CHANGED
@@ -1,7 +1,7 @@
1
1
  # 📦 SQA::Stream
2
2
 
3
3
  !!! abstract "Source Information"
4
- **Defined in:** `lib/sqa/stream.rb:39`
4
+ **Defined in:** [`lib/sqa/stream.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L39)
5
5
 
6
6
  **Inherits from:** `Object`
7
7
 
@@ -15,7 +15,7 @@ Returns the value of attribute ticker.
15
15
 
16
16
 
17
17
  ??? info "Source Location"
18
- `lib/sqa/stream.rb:40`
18
+ [`lib/sqa/stream.rb:40`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L40)
19
19
 
20
20
  ---
21
21
 
@@ -27,7 +27,7 @@ Returns the value of attribute window_size.
27
27
 
28
28
 
29
29
  ??? info "Source Location"
30
- `lib/sqa/stream.rb:40`
30
+ [`lib/sqa/stream.rb:40`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L40)
31
31
 
32
32
  ---
33
33
 
@@ -39,7 +39,7 @@ Returns the value of attribute strategies.
39
39
 
40
40
 
41
41
  ??? info "Source Location"
42
- `lib/sqa/stream.rb:40`
42
+ [`lib/sqa/stream.rb:40`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L40)
43
43
 
44
44
  ---
45
45
 
@@ -51,7 +51,7 @@ Returns the value of attribute data_buffer.
51
51
 
52
52
 
53
53
  ??? info "Source Location"
54
- `lib/sqa/stream.rb:40`
54
+ [`lib/sqa/stream.rb:40`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L40)
55
55
 
56
56
  ---
57
57
 
@@ -63,7 +63,7 @@ Returns the value of attribute indicator_cache.
63
63
 
64
64
 
65
65
  ??? info "Source Location"
66
- `lib/sqa/stream.rb:40`
66
+ [`lib/sqa/stream.rb:40`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L40)
67
67
 
68
68
  ---
69
69
 
@@ -79,7 +79,7 @@ Returns the value of attribute indicator_cache.
79
79
  a new instance of Stream
80
80
 
81
81
  ??? info "Source Location"
82
- `lib/sqa/stream.rb:42`
82
+ [`lib/sqa/stream.rb:42`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L42)
83
83
 
84
84
  ---
85
85
 
@@ -91,7 +91,7 @@ Add a strategy to the stream processor
91
91
 
92
92
 
93
93
  ??? info "Source Location"
94
- `lib/sqa/stream.rb:65`
94
+ [`lib/sqa/stream.rb:65`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L65)
95
95
 
96
96
  ---
97
97
 
@@ -108,7 +108,7 @@ Example:
108
108
 
109
109
 
110
110
  ??? info "Source Location"
111
- `lib/sqa/stream.rb:78`
111
+ [`lib/sqa/stream.rb:78`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L78)
112
112
 
113
113
  ---
114
114
 
@@ -125,7 +125,7 @@ Example:
125
125
 
126
126
 
127
127
  ??? info "Source Location"
128
- `lib/sqa/stream.rb:89`
128
+ [`lib/sqa/stream.rb:89`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L89)
129
129
 
130
130
  ---
131
131
 
@@ -140,7 +140,7 @@ Optional fields: volume, high, low, timestamp
140
140
 
141
141
 
142
142
  ??? info "Source Location"
143
- `lib/sqa/stream.rb:98`
143
+ [`lib/sqa/stream.rb:98`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L98)
144
144
 
145
145
  ---
146
146
 
@@ -152,7 +152,7 @@ Get current price
152
152
 
153
153
 
154
154
  ??? info "Source Location"
155
- `lib/sqa/stream.rb:136`
155
+ [`lib/sqa/stream.rb:136`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L136)
156
156
 
157
157
  ---
158
158
 
@@ -164,7 +164,7 @@ Get recent prices
164
164
 
165
165
 
166
166
  ??? info "Source Location"
167
- `lib/sqa/stream.rb:141`
167
+ [`lib/sqa/stream.rb:141`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L141)
168
168
 
169
169
  ---
170
170
 
@@ -176,7 +176,7 @@ Get recent volumes
176
176
 
177
177
 
178
178
  ??? info "Source Location"
179
- `lib/sqa/stream.rb:148`
179
+ [`lib/sqa/stream.rb:148`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L148)
180
180
 
181
181
  ---
182
182
 
@@ -192,7 +192,7 @@ Example:
192
192
 
193
193
 
194
194
  ??? info "Source Location"
195
- `lib/sqa/stream.rb:159`
195
+ [`lib/sqa/stream.rb:159`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L159)
196
196
 
197
197
  ---
198
198
 
@@ -204,7 +204,7 @@ Get current trading signal from last strategy execution
204
204
 
205
205
 
206
206
  ??? info "Source Location"
207
- `lib/sqa/stream.rb:177`
207
+ [`lib/sqa/stream.rb:177`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L177)
208
208
 
209
209
  ---
210
210
 
@@ -216,7 +216,7 @@ Get statistics about the stream
216
216
 
217
217
 
218
218
  ??? info "Source Location"
219
- `lib/sqa/stream.rb:182`
219
+ [`lib/sqa/stream.rb:182`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L182)
220
220
 
221
221
  ---
222
222
 
@@ -228,7 +228,7 @@ Reset the stream (clear all data)
228
228
 
229
229
 
230
230
  ??? info "Source Location"
231
- `lib/sqa/stream.rb:199`
231
+ [`lib/sqa/stream.rb:199`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L199)
232
232
 
233
233
  ---
234
234
 
data/docs/api-reference/sqa_ticker.md CHANGED
@@ -7,7 +7,7 @@
7
7
  Downloads and caches a CSV file containing ticker symbols, company names, and exchanges.
8
8
 
9
9
  !!! abstract "Source Information"
10
- **Defined in:** `lib/sqa/ticker.rb:15`
10
+ **Defined in:** [`lib/sqa/ticker.rb:15`](https://github.com/madbomber/sqa/blob/main/lib/sqa/ticker.rb#L15)
11
11
 
12
12
  **Inherits from:** `Object`
13
13
 
@@ -35,7 +35,7 @@ Downloads ticker data from dumbstockapi.com and saves to data directory.
35
35
  SQA::Ticker.download("US") # => 200
36
36
  ```
37
37
  ??? info "Source Location"
38
- `lib/sqa/ticker.rb:31`
38
+ [`lib/sqa/ticker.rb:31`](https://github.com/madbomber/sqa/blob/main/lib/sqa/ticker.rb#L31)
39
39
 
40
40
  ---
41
41
 
@@ -54,7 +54,7 @@ Retries download up to 3 times if no cached file exists.
54
54
  Hash mapping ticker symbols to info hashes
55
55
 
56
56
  ??? info "Source Location"
57
- `lib/sqa/ticker.rb:47`
57
+ [`lib/sqa/ticker.rb:47`](https://github.com/madbomber/sqa/blob/main/lib/sqa/ticker.rb#L47)
58
58
 
59
59
  ---
60
60
 
@@ -76,7 +76,7 @@ Loads ticker data from a specific CSV file.
76
76
  Hash mapping ticker symbols to info hashes
77
77
 
78
78
  ??? info "Source Location"
79
- `lib/sqa/ticker.rb:77`
79
+ [`lib/sqa/ticker.rb:77`](https://github.com/madbomber/sqa/blob/main/lib/sqa/ticker.rb#L77)
80
80
 
81
81
  ---
82
82
 
@@ -94,7 +94,7 @@ Returns the cached ticker data, loading it if necessary.
94
94
  Hash mapping ticker symbols to info hashes
95
95
 
96
96
  ??? info "Source Location"
97
- `lib/sqa/ticker.rb:92`
97
+ [`lib/sqa/ticker.rb:92`](https://github.com/madbomber/sqa/blob/main/lib/sqa/ticker.rb#L92)
98
98
 
99
99
  ---
100
100
 
@@ -121,7 +121,7 @@ Looks up information for a specific ticker symbol.
121
121
  SQA::Ticker.lookup('FAKE') # => nil
122
122
  ```
123
123
  ??? info "Source Location"
124
- `lib/sqa/ticker.rb:106`
124
+ [`lib/sqa/ticker.rb:106`](https://github.com/madbomber/sqa/blob/main/lib/sqa/ticker.rb#L106)
125
125
 
126
126
  ---
127
127
 
@@ -148,7 +148,7 @@ Checks if a ticker symbol is valid (exists in the data).
148
148
  SQA::Ticker.valid?(nil) # => false
149
149
  ```
150
150
  ??? info "Source Location"
151
- `lib/sqa/ticker.rb:120`
151
+ [`lib/sqa/ticker.rb:120`](https://github.com/madbomber/sqa/blob/main/lib/sqa/ticker.rb#L120)
152
152
 
153
153
  ---
154
154
 
@@ -167,7 +167,7 @@ Useful for testing to force a fresh load.
167
167
  Empty hash
168
168
 
169
169
  ??? info "Source Location"
170
- `lib/sqa/ticker.rb:129`
170
+ [`lib/sqa/ticker.rb:129`](https://github.com/madbomber/sqa/blob/main/lib/sqa/ticker.rb#L129)
171
171
 
172
172
  ---
173
173