Skip to content

contango.trading.metrics.calculators.returns

contango.trading.metrics.calculators.returns

get_return_metrics 

get_return_metrics(context: AnalysisContext) -> ReturnMetrics

Returns the ReturnMetrics for the given context.

Parameters:

Name Type Description Default
context AnalysisContext

The AnalysisContext object to derive data from.

 required

Returns:

Type Description
ReturnMetrics

A ReturnMetrics object with all the metrics relating to returns.
Source code in src\contango\trading\metrics\calculators\returns.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
def get_return_metrics(context: AnalysisContext) -> ReturnMetrics:
    """
    Returns the `ReturnMetrics` for the given context.

    Args:
        context: The `AnalysisContext` object to derive data from.

    Returns:
        A `ReturnMetrics` object with all the metrics relating to returns.
    """
    total_return = _get_total_return(context.equity_curve)
    monthly_returns = _get_monthly_returns(context.equity_curve)
    equity_curve = context.equity_curve
    return ReturnMetrics(
        total_return=total_return,
        monthly_returns=monthly_returns,
        equity_curve=equity_curve
    )