QuantConnect.Report.Report Class Reference

Report class More...

Public Member Functions
	Report (string name, string description, string version, BacktestResult backtest, LiveResult live, string pointInTimePortfolioDestination=null, string cssOverride=null, string htmlCustom=null)
	Create beautiful HTML and PDF Reports based on backtest and live data. More...
void	Compile (out string html, out string reportStatistics)
	Compile the backtest data into a report More...

Static Public Member Functions
static string	GetRegexInInput (string pattern, string input)
	Gets the regex pattern in the given input string More...

Static Public Attributes
const string	StatisticsFileName = "report-statistics.json"
	File name for statistics More...

Detailed Description

Report class

Definition at line 34 of file Report.cs.

Constructor & Destructor Documentation

Report()

QuantConnect.Report.Report.Report	(	string	name,
		string	description,
		string	version,
		BacktestResult	backtest,
		LiveResult	live,
		string	pointInTimePortfolioDestination = null,
		string	cssOverride = null,
		string	htmlCustom = null
	)

Create beautiful HTML and PDF Reports based on backtest and live data.

Parameters

name	Name of the strategy
description	Description of the strategy
version	Version number of the strategy
backtest	Backtest result object
live	Live result object
pointInTimePortfolioDestination	Point in time portfolio json output base filename
cssOverride	CSS file that overrides some of the default rules defined in report.css
htmlCustom	Custom HTML file to replace the default template

Definition at line 55 of file Report.cs.

Here is the call graph for this function:

Member Function Documentation

Compile()

void QuantConnect.Report.Report.Compile	(	out string	html,
		out string	reportStatistics
	)

Compile the backtest data into a report

Returns

Definition at line 168 of file Report.cs.

Here is the call graph for this function:

GetRegexInInput()

static string QuantConnect.Report.Report.GetRegexInInput ( string  pattern, string  input  )

static

Gets the regex pattern in the given input string

Parameters

pattern	Regex pattern to be find the input string
input	Input string that may contain the regex pattern

Returns

The regex pattern in the input string if found. Otherwise, null

Definition at line 197 of file Report.cs.

Here is the caller graph for this function:

Member Data Documentation

StatisticsFileName

const string QuantConnect.Report.Report.StatisticsFileName = "report-statistics.json"

static

File name for statistics

Definition at line 42 of file Report.cs.

---

The documentation for this class was generated from the following file:

• Report/Report.cs