API for EventStudy
Event Study Analysis

Global functions
.advice_schema Source code
.advisor_pro_footer Source code
.aggregate_remainder Source code
.append_returns Source code
.append_windows Source code
.build_advice_from_parsed Source code
.build_export_tables Source code
.build_offline_advice Source code
.build_offline_narrative Source code
.build_output_format Source code
.build_prompt Source code
.build_prose_value_registry Source code
.calc_T_r Source code
.calculate_abnormal_returns Source code
.calculate_multiple_event_test_statistics Source code
.calculate_single_event_test_statistics Source code
.calibrate_significance Source code
.check_aar_caar_shape Source code
.check_shape Source code
.check_single_event_shape Source code
.compute_se Source code
.deprecate_arg Source code
.design_rcond Source code
.detect_stat_column Source code
.empty_advice Source code
.estimate_borusyak_jaravel_spiess Source code
.estimate_callaway_santanna Source code
.estimate_dechaisemartin_dhaultfoeuille Source code
.estimate_dynamic_twfe Source code
.estimate_mm_model Source code
.estimate_static_twfe Source code
.estimate_sun_abraham Source code
.exclude_all_na_events Source code
.export_csv Source code
.export_latex Source code
.export_xlsx Source code
.extract_anthropic_text Source code
.extract_cars Source code
.extract_contract_state Source code
.extract_cross_sectional_signals Source code
.extract_estimation_signals Source code
.extract_event_window_signals Source code
.extract_kb_references Source code
.extract_llm_section_prose Source code
.extract_numeric_literals Source code
.finish_response Source code
.finite_residual_df Source code
.formula_n_params Source code
.generate_synthetic_data Source code
.get_caltime_df Source code
.handle_degenerate Source code
.inform Source code
.initialize_and_fit_model Source code
.is_grounded_literal Source code
.kb_for_prompt Source code
.kb_rule Source code
.kb_to_evidence Source code
.narrative_data_methods Source code
.narrative_exec_summary Source code
.narrative_results Source code
.narrative_robustness Source code
.parse_advice_json Source code
.pdf_toolchain_available Source code
.perform_request Source code
.plot_multi_event Source code
.plot_single_event Source code
.provider_failure Source code
.provider_success Source code
.rank_events_for_cap Source code
.resolve_api_key Source code
.resolve_degenerate_mode Source code
.resolve_diag_key Source code
.resolve_provider_config Source code
.resolve_shape_contract_mode Source code
.resolve_test_stat Source code
.sanitise_for_pdf Source code
.sanitise_for_word Source code
.sanitise_prose Source code
.sanitise_universal Source code
.scan_prose_grounding Source code
.shape_spec_aar_caar Source code
.shape_spec_art Source code
.shape_spec_cart Source code
.solve_sc_optim Source code
.solve_sc_quadprog Source code
.style_plotly Source code
.tidy_aar Source code
.tidy_ar Source code
.tidy_car Source code
.tidy_model Source code
.tinytable_available Source code
.validate_grounding Source code
.warn_short_estimation_window Source code
.word_toolchain_available Source code
ARTTest Man page
AnthropicProvider Man page
BHARModel Man page
BHARTTest Man page
BMPTest Man page
CARTTest Man page
CSectTTest Man page
CalendarTimePortfolioTest Man page
Carhart4FactorModel Man page
ComparisonPeriodMeanAdjustedModel Man page
CustomProvider Man page
DCCGARCHModel Man page
EVENTSTUDY_KB Man page
EventStudy Man page
EventStudy-package Man page
EventStudyTask Man page
FamaFrench3FactorModel Man page
FamaFrench5FactorModel Man page
GARCHModel Man page
GeneralizedSignTest Man page
IntradayEventStudyTask Man page
KolariPynnonenTest Man page
LinearFactorModel Man page
LogReturn Man page
MarketAdjustedModel Man page
MarketModel Man page
ModelBase Man page
MultiEventStatisticsSet Man page
OpenAICompatProvider Man page
PanelEventStudyTask Man page
ParameterSet Man page
PatellZTest Man page
ProviderBase Man page
RankTest Man page
ReturnCalculation Man page
RollingWindowModel Man page
SignTest Man page
SimpleReturn Man page
SingleEventStatisticsSet Man page
StatisticsSetBase Man page
SyntheticControlTask Man page
TestStatisticBase Man page
VolatilityModel Man page
VolumeModel Man page
adjust_p_values Man page Source code
advisor_pro Man page
assemble_report_narrative Source code
bootstrap_test Man page Source code
calculate_statistics Man page Source code
car_by_group Man page Source code
car_quantiles Man page Source code
cross_sectional_regression Man page Source code
degenerate-input-contract Man page
dieselgate Man page
download_factor_data Man page Source code
download_risk_free_rate Man page Source code
download_stock_data Man page Source code
earnings_surprises Man page
es_advise Man page Source code
es_colours Man page
es_diagnostics Man page Source code
es_kb Man page Source code
es_report Man page Source code
estimate_panel_event_study Man page Source code
estimate_synthetic_control Man page Source code
eventstudy-deprecation Man page
eventstudy-shape-contracts Man page
export_results Man page Source code
fit_model Man page Source code
flag_robustness Man page Source code
flag_robustness.EventStudyTask Man page Source code
flag_robustness.default Man page Source code
flag_robustness.es_diagnostics Man page Source code
format.Advice Man page Source code
format.EventStudySummary Man page Source code
format.es_advice Man page Source code
format.es_cross_sectional Man page Source code
format.es_diagnostics Man page Source code
format.es_simulation Man page Source code
generate_report Man page Source code
model_diagnostics Man page Source code
nonparametric_intraday_test Man page Source code
plot_car_distribution Man page Source code
plot_diagnostics Man page Source code
plot_event_study Man page Source code
plot_panel_event_study Man page Source code
plot_stocks Man page Source code
plot_synthetic_control Man page Source code
prepare_event_study Man page Source code
prepare_intraday_event_study Man page Source code
pretrend_test Man page Source code
print.Advice Man page Source code
print.EventStudySummary Man page Source code
print.es_advice Man page Source code
print.es_cross_sectional Man page Source code
print.es_diagnostics Man page Source code
print.es_simulation Source code
provider Man page Source code
recommend_stat Man page Source code
recommend_stat.EventStudyTask Man page Source code
recommend_stat.default Man page Source code
recommend_stat.es_diagnostics Man page Source code
report_table Man page Source code
run_event_study Man page Source code
sc_placebo_test Man page Source code
simulate_event_study Man page Source code
theme_eventstudy Man page Source code
tidy.EventStudyTask Man page Source code
validate_task Man page Source code
EventStudy documentation built on Oct. 31, 2026, 1:07 a.m.