Methods

Development docs · 996102e0
View source

Method explorer

Start from the methodological decision you need to defend, not from a module name. This explorer connects each research question to the smallest relevant public API sequence, a guide or runnable workflow, a diagnostic plot, and—where one genuinely exists—a frozen validation case.

Evidence is not filled in for appearance. A method family without a directly relevant frozen empirical case says so explicitly. Synthetic known-truth benchmarks, live interoperability contracts, and protocol-bound real-data outcomes are different evidence types and remain labelled separately.
10method families
8research phases
3frozen real-data cases
1governed catalog
Preflight 01

Structural QC

Is the canonical gaze table structurally safe to inspect downstream?

Detect non-finite coordinates or timestamps, missing identifiers, duplicate timestamps, and decreasing within-trial time without turning those diagnostics into a universal quality score.

Public API route
GazeStudyaudit_study_qcstudy_qc_diagnosticsbuild_study_qc_audit
Evidence boundary

Descriptive preflight; no frozen real-data outcome is assigned to this method family.

QC issue profile diagnostic preview
Governance 02

Analysis-readiness governance

What cohort consequences follow from the structural policy I declare?

Aggregate trial and participant diagnostics, preview retention consequences, compare declared policies, and preserve the policy as provenance rather than as an automatic exclusion rule.

Public API route
ReadinessThresholdsevaluate_analysis_readinesscohort_impact_previewreadiness_policy_table
Evidence boundary

Policy-relative governance; passing a policy is not a universal scientific-validity judgement.

Cohort-impact preview diagnostic preview
Measurement 03

AOI measurement uncertainty

Would the endpoint change if gaze coordinates near AOI boundaries were not treated as exact?

Represent declared gaze-position error, estimate probabilistic AOI membership, compare it with hard assignment, and propagate measurement uncertainty into dwell or fixation endpoints.

Public API route
GaussianGazeErrorModelaoi_probabilitiescompare_hard_probabilisticexpected_dwell
Evidence boundary

The frozen Korthals audit retained a negative paired effect under the prespecified uncertainty model. Korthals frozen case →

AOI probability profile diagnostic preview
Robustness 04

Specification-space robustness

Does the endpoint survive other defensible analytical choices?

Declare a finite decision space, execute one common endpoint across valid specifications, and inspect sign, magnitude, and factor sensitivity without searching for a favourable pipeline.

Public API route
PipelineSpacerun_specsspecification_curveeffect_stability
Evidence boundary

The frozen GazeBase programme stopped at its predeclared completeness gate rather than forcing a robustness conclusion. GazeBase frozen case →

Specification curve diagnostic preview
Sensitivity 05

Sampling-rate sensitivity

How much does the endpoint move as temporal sampling resolution is reduced?

Downsample by retaining existing samples nearest a declared target grid and evaluate the same endpoint across controlled sampling rates without coordinate interpolation.

Public API route
downsample_gazesampling_sensitivity_curve
Evidence boundary

The frozen Pedrotti/de Chambrier audit found materially degraded magnitude recovery at lower sampling rates. Pedrotti frozen case →

Sampling sensitivity diagnostic preview
Sensitivity 06

Missingness sensitivity

How robust is the endpoint to controlled amounts and mechanisms of missing gaze data?

Construct declared missingness masks, apply them without hiding the perturbation mechanism, and evaluate endpoint recovery across controlled missingness families.

Public API route
missingness_maskinject_missingnessmissingness_sensitivity_curvesummarize_missingness
Evidence boundary

The frozen Pedrotti/de Chambrier protocol includes controlled MCAR and single-block missingness recovery. Pedrotti frozen case →

Missingness sensitivity diagnostic preview
Sensitivity 07

Spatial-error sensitivity

How dependent is the endpoint on the scale of the declared gaze-error model?

Scale an explicit measurement-error model and rerun a common endpoint across controlled spatial uncertainty levels.

Public API route
scale_error_modelspatial_sensitivity_curve
Evidence boundary

Korthals provides frozen measurement-error propagation evidence; it is not a generic spatial-sensitivity benchmark. Korthals measurement case →

Factor sensitivity diagnostic preview
Benchmarking 08

Known-truth recovery

Can the analysis family recover a conclusion when the generating truth is known?

Simulate declared AOI effects, evaluate recovery under a predeclared conclusion rule, and compare analysis families without confusing synthetic recovery with empirical validation.

Public API route
simulate_known_aoi_effectbenchmark_known_aoi_effectConclusionRulesummarize_conclusion_recovery
Evidence boundary

Synthetic known-truth benchmark by design; it is not a frozen real-data case study.

Recovery matrix diagnostic preview
Evidence 09

Publication provenance

Can another researcher verify exactly what was declared, run, and reported?

Bind results, rules, manifests, methods text, software metadata, and content fingerprints into deterministic publication evidence that can be verified after writing.

Public API route
build_conclusion_audit_bundleverify_publication_audit_bundlerender_publication_methodsfingerprint
Evidence boundary

The validation matrix shows how outcome labels remain bound to exact protocol and execution records. Frozen validation matrix →

Policy trade-offs diagnostic preview
Integration 10

Interoperability

How do I bring external eye-tracking data or detector outputs into the canonical audit workflow?

Convert supported BIDS, pymovements, pEYES, or custom adapter inputs into explicit GazeAudit contracts while keeping upstream semantics visible.

Public API route
read_bids_eyetrackfrom_pymovements_gazemake_peyes_detectorrun_detector_backend
Evidence boundary

Interoperability is guarded by live contract CI; it is not itself a frozen empirical outcome.

Gaze trajectory and AOI diagnostic preview

How to use the map

The public API route is a compact orientation sequence, not a mandatory pipeline. The linked guides explain inputs, assumptions, return objects, and scientific boundaries in more detail. A plot link identifies a diagnostic that helps inspect the method; it does not imply that a visual threshold determines validity.

The evidence boundary is deliberately conservative. Frozen case-study labels remain protocol-bound records: incomplete for GazeBase, robust_negative for Korthals, and materially_fragile for Pedrotti/de Chambrier. Synthetic benchmarks and CI interoperability checks are not silently promoted to empirical validation.

Need the full function inventory?

Use the task-oriented API map for broader function coverage, or the CI-protected core API inventory when you need the governed export list.

Documentation search

Find the right documentation

↑↓ navigateEnter openEsc close