sqa 0.0.32 → 0.0.37

data/docs/api-reference/sqa_backtest_results.md

@@ -0,0 +1,530 @@
+# 📦 SQA::Backtest::Results
+
+!!! note "Description"
+    Represents the results of a backtest
+
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/backtest.rb:11`
+    
+    **Inherits from:** `Object`
+
+## 🔨 Instance Methods
+
+### `#total_return()`
+
+Returns the value of attribute total_return.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#total_return=(value)`
+
+Sets the attribute total_return
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute total_return to. |
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#annualized_return()`
+
+Returns the value of attribute annualized_return.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#annualized_return=(value)`
+
+Sets the attribute annualized_return
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute annualized_return to. |
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#sharpe_ratio()`
+
+Returns the value of attribute sharpe_ratio.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#sharpe_ratio=(value)`
+
+Sets the attribute sharpe_ratio
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute sharpe_ratio to. |
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#max_drawdown()`
+
+Returns the value of attribute max_drawdown.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#max_drawdown=(value)`
+
+Sets the attribute max_drawdown
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute max_drawdown to. |
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#total_trades()`
+
+Returns the value of attribute total_trades.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#total_trades=(value)`
+
+Sets the attribute total_trades
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute total_trades to. |
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#winning_trades()`
+
+Returns the value of attribute winning_trades.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#winning_trades=(value)`
+
+Sets the attribute winning_trades
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute winning_trades to. |
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#losing_trades()`
+
+Returns the value of attribute losing_trades.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#losing_trades=(value)`
+
+Sets the attribute losing_trades
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute losing_trades to. |
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#win_rate()`
+
+Returns the value of attribute win_rate.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#win_rate=(value)`
+
+Sets the attribute win_rate
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute win_rate to. |
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#average_win()`
+
+Returns the value of attribute average_win.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#average_win=(value)`
+
+Sets the attribute average_win
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute average_win to. |
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#average_loss()`
+
+Returns the value of attribute average_loss.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#average_loss=(value)`
+
+Sets the attribute average_loss
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute average_loss to. |
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#profit_factor()`
+
+Returns the value of attribute profit_factor.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#profit_factor=(value)`
+
+Sets the attribute profit_factor
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute profit_factor to. |
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#start_date()`
+
+Returns the value of attribute start_date.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#start_date=(value)`
+
+Sets the attribute start_date
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute start_date to. |
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#end_date()`
+
+Returns the value of attribute end_date.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#end_date=(value)`
+
+Sets the attribute end_date
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute end_date to. |
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#initial_capital()`
+
+Returns the value of attribute initial_capital.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#initial_capital=(value)`
+
+Sets the attribute initial_capital
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute initial_capital to. |
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#final_value()`
+
+Returns the value of attribute final_value.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#final_value=(value)`
+
+Sets the attribute final_value
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute final_value to. |
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+
+---
+
+### `#initialize()`
+
+
+!!! success "Returns"
+
+    **Type:** `Results`
+
+    
+
+    a new instance of Results
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:17`
+
+---
+
+### `#to_h()`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:31`
+
+---
+
+### `#summary()`
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:51`
+
+---
+
+## 📝 Attributes
+
+### 🔄 `total_return` <small>read/write</small>
+
+Returns the value of attribute total_return.
+
+### 🔄 `annualized_return` <small>read/write</small>
+
+Returns the value of attribute annualized_return.
+
+### 🔄 `sharpe_ratio` <small>read/write</small>
+
+Returns the value of attribute sharpe_ratio.
+
+### 🔄 `max_drawdown` <small>read/write</small>
+
+Returns the value of attribute max_drawdown.
+
+### 🔄 `total_trades` <small>read/write</small>
+
+Returns the value of attribute total_trades.
+
+### 🔄 `winning_trades` <small>read/write</small>
+
+Returns the value of attribute winning_trades.
+
+### 🔄 `losing_trades` <small>read/write</small>
+
+Returns the value of attribute losing_trades.
+
+### 🔄 `win_rate` <small>read/write</small>
+
+Returns the value of attribute win_rate.
+
+### 🔄 `average_win` <small>read/write</small>
+
+Returns the value of attribute average_win.
+
+### 🔄 `average_loss` <small>read/write</small>
+
+Returns the value of attribute average_loss.
+
+### 🔄 `profit_factor` <small>read/write</small>
+
+Returns the value of attribute profit_factor.
+
+### 🔄 `start_date` <small>read/write</small>
+
+Returns the value of attribute start_date.
+
+### 🔄 `end_date` <small>read/write</small>
+
+Returns the value of attribute end_date.
+
+### 🔄 `initial_capital` <small>read/write</small>
+
+Returns the value of attribute initial_capital.
+
+### 🔄 `final_value` <small>read/write</small>
+
+Returns the value of attribute final_value.
+

data/docs/api-reference/sqa_badparametererror.md

@@ -0,0 +1,13 @@
+# 📦 SQA::BadParameterError
+
+!!! note "Description"
+    Raised when a method parameter is invalid.
+    Inherits from ArgumentError for semantic clarity.
+
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/errors.rb:54`
+    
+    **Inherits from:** `ArgumentError`
+
+## 📝 Attributes
+