scenarioplanner.converters.dataframe.marketing_analyses_converters.MediaOutcomeConverter

Outputs a "MediaOutcome" table.

Inherits From: Converter

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

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

• "Channel Index" This is to ensure "baseline" and "All Channels" can be sorted to appear first and last, respectively, in LS dashboard.
• "Channel"
• "Incremental Outcome"
• "Contribution Share"
• "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.