cleverly.datasets.navigation_protocol

cleverly.datasets.navigation_protocol() → StudyProtocol

Return the protocol for the standard navigation offer in the tutorial program.

Returns:

StudyProtocol

The point-treatment protocol that compares the standard navigation offer with usual discharge support on the 30-day transition score.

See also

cleverly.StudyProtocol

The record this function fills.

cleverly.datasets.navigation_data

The program data the point-treatment tutorials draw.

cleverly.datasets.longitudinal_navigation_protocol

The protocol of the two-decision program.

Notes

The values restate the shared study design in docs/examples/index.md. A tutorial whose question changes a field, such as the assumption rationale or the strategies, passes the result to dataclasses.replace(). The synthetic generators make the identification assumptions true by construction. The rationale here describes the program, not the draw.

The outcome field states the score’s support. A cross-fitted fit of a continuous outcome declares that support as q_bounds, so a tutorial whose synthetic stand-in has another support replaces this field and says which fit that support allows.

Examples

>>> from dataclasses import replace
>>> from cleverly.datasets import navigation_protocol
>>> protocol = navigation_protocol()
>>> protocol.horizon
'30 days after discharge'
>>> protocol.fingerprint
'623fc2c240615d26'

A tutorial with another question replaces only the fields that question changes:

>>> screened = replace(protocol, interference_unit="Navigator team")
>>> screened.outcome == protocol.outcome
True
>>> screened.fingerprint == protocol.fingerprint
False