FalconResult

FalconResult(
    scores,
    obs,
    manifest,
    registry,
    coverage=dict(),
    skipped=dict(),
    se=None,
)

Scores plus everything needed to say where they came from.

scores is samples x clocks. Everything else – coverage, warnings, weight digests, the resolved config – hangs off the manifest, so a result written to disk and read back is self-describing.

Methods

Name	Description
evidence	Published effect sizes for the clocks in this result.
interpretation	One row per clock: what the number is, and what may be done with it.
long	One row per sample per clock, with the scale and provenance attached.

evidence

FalconResult.evidence(clock=None)

Published effect sizes for the clocks in this result.

The step between a number and something a reader can act on. See :func:falconage.registry.evidence; every row carries its DOI.

interpretation

FalconResult.interpretation()

One row per clock: what the number is, and what may be done with it.

Everything needed to read a score, in the object holding the score. Scale and unit say what the quantity is; legal_operations says which arithmetic the package will perform on it; reliability says how much of a within-person change is likely to be the assay; caveats carries any documented disagreement between the clock’s paper and the coefficients that circulate for it.

long

FalconResult.long()

One row per sample per clock, with the scale and provenance attached.

The scale column is not decoration: it is what stops a reader averaging a mortality log-hazard with an age in years because both were numbers in a column called value.