scenarioplanner.converters.dataframe.marketing_analyses_converters.MediaRoiConverter

Outputs a "MediaROI" table.

Inherits From: Converter

scenarioplanner.converters.dataframe.marketing_analyses_converters.MediaRoiConverter(
    mmm_wrapper: scenarioplanner.converters.mmm.Mmm
)

When called, this converter yields a data frame with the columns:

• "Channel"
• "Spend"
• "Effectiveness"
• "ROI"
• "ROI CI Low" The confidence interval (low) of "ROI" above.
• "ROI CI High" The confidence interval (high) of "ROI" above.
• "Marginal ROI"
• "Is Revenue KPI" A boolean indicating whether "ROI" refers to revenue or generic KPI.
• "Analysis Period" A human-readable analysis period.
• "Analysis Date Start" A string formatted with Meridian date format: YYYY-mm-dd
• "Analysis Date End" A string formatted with Meridian date format: YYYY-mm-dd

Note: If the underlying model analysis works with a revenue-type KPI (i.e. dollar value), then all values in the columns of the output table should be interpreted the same. Likewise, for non-revenue type KPI. While some channels may define their outcome analyses in terms of both revenue- and nonrevenue-type semantics, the output table here remains uniform.

Methods

__call__

View source

__call__() -> Iterator[tuple[str, pd.DataFrame]]

Call self as a function.