/*
* 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 System.Linq;
using QuantConnect.Data;
using QuantConnect.Interfaces;
using System.Collections.Generic;
using QuantConnect.Data.UniverseSelection;
namespace QuantConnect.Algorithm.CSharp
{
///
/// Custom data universe selection regression algorithm asserting it's behavior. Similar to CustomDataUniverseRegressionAlgorithm but with a custom schedule
///
public class CustomDataUniverseScheduledRegressionAlgorithm : QCAlgorithm, IRegressionAlgorithmDefinition
{
private List _currentUnderlyingSymbols = new();
private readonly Queue _selectionTime = new(new[] {
new DateTime(2014, 03, 25, 0, 0, 0),
new DateTime(2014, 03, 27, 0, 0, 0),
new DateTime(2014, 03, 29, 0, 0, 0)
});
///
/// Initialise the data and resolution required, as well as the cash and start-end dates for your algorithm. All algorithms must initialized.
///
public override void Initialize()
{
SetStartDate(2014, 03, 24);
SetEndDate(2014, 03, 31);
UniverseSettings.Resolution = Resolution.Daily;
UniverseSettings.Schedule.On(DateRules.On(_selectionTime.ToArray()));
AddUniverse("custom-data-universe", UniverseSettings, (coarse) =>
{
Debug($"Universe selection called: {Time} Count: {coarse.Count()}");
var expectedTime = _selectionTime.Dequeue();
if (expectedTime != Time)
{
throw new RegressionTestException($"Unexpected selection time {Time} expected {expectedTime}");
}
return coarse.OfType().OrderByDescending(x => x.DollarVolume)
.SelectMany(x => new[] {
x.Symbol,
QuantConnect.Symbol.CreateBase(typeof(CustomData), x.Symbol)})
.Take(20);
});
// This use case is also valid/same because it will use the algorithm settings by default
// AddUniverse("custom-data-universe", (coarse) => {});
}
///
/// OnData event is the primary entry point for your algorithm. Each new data point will be pumped in here.
///
/// Slice object keyed by symbol containing the stock data
public override void OnData(Slice slice)
{
if (!Portfolio.Invested)
{
var customData = slice.Get();
if (customData.Count > 0)
{
foreach (var symbol in _currentUnderlyingSymbols)
{
SetHoldings(symbol, 1m / _currentUnderlyingSymbols.Count);
if (!customData.Any(custom => custom.Key.Underlying == symbol))
{
throw new RegressionTestException($"Custom data was not found for underlying symbol {symbol}");
}
}
}
}
// equity daily data arrives at 16 pm but custom data is set to arrive at midnight
_currentUnderlyingSymbols = slice.Keys.Where(symbol => symbol.SecurityType != SecurityType.Base).ToList();
}
public override void OnEndOfAlgorithm()
{
if (_selectionTime.Count != 0)
{
throw new RegressionTestException($"Unexpected selection times, missing {_selectionTime.Count}");
}
}
///
/// This is used by the regression test system to indicate if the open source Lean repository has the required data to run this algorithm.
///
public bool CanRunLocally { get; } = true;
///
/// This is used by the regression test system to indicate which languages this algorithm is written in.
///
public List Languages { get; } = new() { Language.CSharp, Language.Python };
///
/// Data Points count of all timeslices of algorithm
///
public long DataPoints => 21374;
///
/// Data Points count of the algorithm history
///
public int AlgorithmHistoryDataPoints => 0;
///
/// Final status of the algorithm
///
public AlgorithmStatus AlgorithmStatus => AlgorithmStatus.Completed;
///
/// This is used by the regression test system to indicate what the expected statistics are from running the algorithm
///
public Dictionary ExpectedStatistics => new Dictionary
{
{"Total Orders", "7"},
{"Average Win", "0%"},
{"Average Loss", "0%"},
{"Compounding Annual Return", "-65.964%"},
{"Drawdown", "3.000%"},
{"Expectancy", "0"},
{"Start Equity", "100000"},
{"End Equity", "97665.47"},
{"Net Profit", "-2.335%"},
{"Sharpe Ratio", "-3.693"},
{"Sortino Ratio", "-2.881"},
{"Probabilistic Sharpe Ratio", "6.625%"},
{"Loss Rate", "0%"},
{"Win Rate", "0%"},
{"Profit-Loss Ratio", "0"},
{"Alpha", "-1.175"},
{"Beta", "1.621"},
{"Annual Standard Deviation", "0.156"},
{"Annual Variance", "0.024"},
{"Information Ratio", "-9.977"},
{"Tracking Error", "0.095"},
{"Treynor Ratio", "-0.355"},
{"Total Fees", "$13.86"},
{"Estimated Strategy Capacity", "$510000000.00"},
{"Lowest Capacity Asset", "NB R735QTJ8XC9X"},
{"Portfolio Turnover", "12.76%"},
{"Drawdown Recovery", "0"},
{"OrderListHash", "4668d7bd05e2db15ff41d4e1aac621ab"}
};
}
}