CAGRReportElement.cs

/*
 * 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.
*/
 
using System;
using Deedle;
using QuantConnect.Packets;
 
namespace QuantConnect.Report.ReportElements
{
    internal sealed class CAGRReportElement : ReportElement
    {
        private LiveResult _live;
        private BacktestResult _backtest;
 
        /// <summary>
        /// Estimate the CAGR of the strategy.
        /// </summary>
        /// <param name="name">Name of the widget</param>
        /// <param name="key">Location of injection</param>
        /// <param name="backtest">Backtest result object</param>
        /// <param name="live">Live result object</param>
        public CAGRReportElement(string name, string key, BacktestResult backtest, LiveResult live)
        {
            _live = live;
            _backtest = backtest;
            Name = name;
            Key = key;
        }
 
        /// <summary>
        /// The generated output string to be injected
        /// </summary>
        public override string Render()
        {
            var equityCurve = _live == null
                ? new Series<DateTime, double>(ResultsUtil.EquityPoints(_backtest))
                : DrawdownCollection.NormalizeResults(_backtest, _live);
 
            if (equityCurve.IsEmpty)
            {
                return "-";
            }
            
            var years = (decimal)(equityCurve.LastKey() - equityCurve.FirstKey()).TotalDays / 365m;
            
            Result = Statistics.Statistics.CompoundingAnnualPerformance(
                equityCurve.FirstValue().SafeDecimalCast(),
                equityCurve.LastValue().SafeDecimalCast(),
                years);
            
            return ((decimal?)Result)?.ToString("P1") ?? "-";
        }
    }
}