Files
JosueNina 7008d17714
API Tests / build (push) Has been cancelled
Benchmarks / build (push) Has been cancelled
Build & Test Lean / build (push) Has been cancelled
Regression Tests / build (push) Has been cancelled
Report Generator Tests / build (push) Has been cancelled
Research Regression Tests / build (push) Has been cancelled
Syntax Tests / build (push) Has been cancelled
Python Virtual Environments / build (push) Has been cancelled
Add MaxDrawdownRecovery metric (#8865)
* Implement  a prototype of the maximum recovery time function.

* Add unit test skeletons.

* Add failing test

* Issue #4581: Implement MaxDrawdownRecoveryTime.

* Issue 4581: Add DTO for Drawdown Percentage, Drawdown Enddate, and High Value

* Issue 4581: Fix bgu for when lDrawdowns list is empty.

* Issue 4581: Change names of tests. Change name of file.

* Issue 4581: Make adjustements to flow of adding drawdowns to lDrawdowns.

* Issue 4581: Add multiple unit tests.

* Issue #4581: Change name of unit test

* Issue #4581: Add to PerformanceMetrics

* Issue #4581: Add Maximum Drawdown Recovery to PortolioStatistics class.

* Issue #4581: Add to portolfio statistics class.

* Issue #4581: Add to statistics builder.

* Issue #4581: Add report key.

* Case #4581: Convert to decimal.

* Issue #4581: Correct comment.

* Issue #4581: Correct performance metrics view model string.

* Case #4581: Correct statistics builder view model string..again.

* Issue #4581: Placed DradownDradownDateHighValueDTO at the end of the file for simpler diff.

* Issue #4581: Add 2 new tests.

* Issue #4581: Change algorithm so that when multiple maximum drawdowns occur, the longest of all recoveries is reported.

* Issue #4581: Add unit test.

* Issue #4581: Remove reportkey. Change dto name.

* Issue #4581: Change summary.

* Issue #4581: Change comment.

* Add max drawdown recovery calculation with unit tests

* Update regression algorithms with the new metric

* Solve review comments

* Update regression algorithms

* Add TryGet to safely get the key: MaximumDrawdownRecovery

* Ignore MaximumDrawdownRecovery metric in OptimizationBacktest Json

* Revert changes in Messaging

* Update regression algorithms

* Add test case: TakesLongestRecoveryAmongMultipleDrawdowns

* Use integer days for MaximumDrawdownRecovery

* Add MaximumDrawdownRecoveryReportElement

* Use more explicit names

* Rename files and variables for consistency

* Update regression algorithms

---------

Co-authored-by: Alain Schaerer <aschaerer@pcatg.com>
2025-07-17 16:32:23 -03:00

63 lines
3.3 KiB
C#

/*
* QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
* Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
*
* 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.
*/
namespace QuantConnect.Report
{
/// <summary>
/// Helper shortcuts for report injection points.
/// </summary>
internal static class ReportKey
{
public const string Stylesheet = @"{{$REPORT-STYLESHEET}}";
public const string StrategyName = @"{{$TEXT-STRATEGY-NAME}}";
public const string StrategyDescription = @"{{$TEXT-STRATEGY-DESCRIPTION}}";
public const string StrategyVersion = @"{{$TEXT-STRATEGY-VERSION}}";
public const string LiveMarker = @"{{$LIVE-MARKER}}";
public const string ParametersPageStyle = @"{{$CSS-PARAMETERS-PAGE-STYLE}}";
public const string Parameters = @"{{$PARAMETERS}}";
public const string CAGR = @"{{$KPI-CAGR}}";
public const string Turnover = @"{{$KPI-TURNOVER}}";
public const string MaxDrawdown = @"{{$KPI-DRAWDOWN}}";
public const string MaxDrawdownRecovery = @"{{$KPI-DRAWDOWN-RECOVERY}}";
public const string KellyEstimate = @"{{$KPI-KELLY-ESTIMATE}}";
public const string SharpeRatio = @"{{$KPI-SHARPE}}";
public const string SortinoRatio = @"{{$KPI-SORTINO}}";
public const string BacktestDays = @"{{$KPI-BACKTEST-DAYS}}";
public const string DaysLive = @"{{$KPI-DAYS-LIVE}}";
public const string InformationRatio = @"{{$KPI-INFORMATION-RATIO}}";
public const string TradesPerDay = @"{{$KPI-TRADES-PER-DAY}}";
public const string Markets = @"{{$KPI-MARKETS}}";
public const string PSR = @"{{$KPI-PSR}}";
public const string StrategyCapacity = @"{{$KPI-STRATEGY-CAPACITY}}";
public const string MonthlyReturns = @"{{$PLOT-MONTHLY-RETURNS}}";
public const string CumulativeReturns = @"{{$PLOT-CUMULATIVE-RETURNS}}";
public const string AnnualReturns = @"{{$PLOT-ANNUAL-RETURNS}}";
public const string ReturnsPerTrade = @"{{$PLOT-RETURNS-PER-TRADE}}";
public const string AssetAllocation = @"{{$PLOT-ASSET-ALLOCATION}}";
public const string Drawdown = @"{{$PLOT-DRAWDOWN}}";
public const string DailyReturns = @"{{$PLOT-DAILY-RETURNS}}";
public const string RollingBeta = @"{{$PLOT-BETA}}";
public const string RollingSharpe = @"{{$PLOT-SHARPE}}";
public const string LeverageUtilization = @"{{$PLOT-LEVERAGE}}";
public const string Exposure = @"{{$PLOT-EXPOSURE}}";
public const string CrisisPageStyle = @"{{$CSS-CRISIS-PAGE-STYLE}}";
public const string CrisisPlots = @"{{$HTML-CRISIS-PLOTS}}";
public const string CrisisTitle = @"{{$TEXT-CRISIS-TITLE}}";
public const string CrisisContents = @"{{$PLOT-CRISIS-CONTENT}}";
}
}