cleverly.datasets.offers_protocol

cleverly.datasets.offers_protocol() → StudyProtocol

Return the protocol of the weekly-offer campaign.

Returns:

StudyProtocol

The protocol that compares five offer plans over three weekly sends, on a full-price order in week 4.

See also

make_sequential_offers

The synthetic law that draws data for this protocol.

cleverly.StudyProtocol

The record this function fills.

cleverly.datasets.longitudinal_navigation_protocol

The protocol of the health program.

Notes

The record states time zero, eligibility, the treatment versions, the outcome horizon, and the interference unit. The available history and the confounders are not protocol fields. The assumption rationale names the confounders, and a design prints the history at each node.

Examples

>>> from cleverly.datasets import offers_protocol
>>> protocol = offers_protocol()
>>> len(protocol.treatment_strategies)
5
>>> protocol.horizon
'Week 4, the week after the third weekly send'