cleverly.datasets.longitudinal_navigation_protocol

cleverly.datasets.longitudinal_navigation_protocol() → StudyProtocol

Return the protocol for navigation offered at two decisions after discharge.

Returns:

StudyProtocol

The protocol that compares navigation at discharge and day seven with no navigation at either decision, on the top-box transition score at day 30.

See also

cleverly.datasets.navigation_protocol

The protocol of the one-decision program.

cleverly.datasets.make_longitudinal

The synthetic law the two-decision tutorial draws.

Notes

Time zero is the discharge itself, so eligibility requires a live discharge. The strategies name the two static plans. A tutorial that reports another plan or a dynamic rule appends its strategy and its version with dataclasses.replace(), and a tutorial with another outcome replaces the outcome, the horizon, and the intercurrent-event handling.

Examples

>>> from dataclasses import replace
>>> from cleverly.datasets import longitudinal_navigation_protocol
>>> program = longitudinal_navigation_protocol()
>>> program.treatment_strategies
('Offer navigation at discharge and day seven', 'Offer no navigation at either decision')
>>> program.fingerprint
'0fe91ade3fc3f249'

A tutorial that also reports a dynamic rule names it as a third strategy:

>>> with_rule = replace(
...     program,
...     treatment_strategies=(
...         *program.treatment_strategies,
...         "Offer navigation at discharge, and continue on day seven if engaged",
...     ),
...     treatment_versions=(
...         *program.treatment_versions,
...         "The discharge contact, and the day-seven contact for engaged patients",
...     ),
... )
>>> len(with_rule.treatment_strategies)
3