Module Reference

Complete API reference for all CAIS modules. This documentation is automatically generated from the source code docstrings.

Core Modules

• causal_agent
  • causal_agent.analyze_dataset
    • analyze_dataset()
  • causal_agent.create_workflow_state_update
    • create_workflow_state_update()
  • causal_agent.format_output
    • format_output()
  • causal_agent.generate_explanation
    • generate_explanation()
  • causal_agent.interpret_query
    • interpret_query()
  • causal_agent.parse_input
    • parse_input()
  • causal_agent.run_causal_analysis
    • run_causal_analysis()
  • causal_agent.validate_method
    • validate_method()
  • run_causal_analysis()
• causal_agent.components package
  • parse_input()
  • analyze_dataset()
  • interpret_query()
  • select_method()
  • validate_method()
  • generate_explanation()
  • format_output()
  • create_workflow_state_update()
  • Submodules
  • causal_agent.components.dataset_analyzer module
    • analyze_dataset()
    • detect_temporal_structure()
    • find_potential_instruments()
    • detect_discontinuities()
    • assess_variable_relationships()
  • causal_agent.components.decision_tree module
    • select_method()
    • rule_based_select_method()
    • DecisionTreeEngine
  • causal_agent.components.decision_tree_llm module
    • DecisionTreeLLMEngine
  • causal_agent.components.explanation_generator module
    • generate_explanation()
    • get_method_explanation()
    • explain_assumptions()
    • explain_application()
    • explain_limitations()
    • generate_interpretation_guide()
  • causal_agent.components.input_parser module
    • ParsedVariables
    • ParsedQueryInfo
    • ExtractedPath
    • extract_dataset_path()
    • parse_input()
    • extract_dataset_path_regex()
  • causal_agent.components.method_validator module
    • validate_method()
    • validate_propensity_score_matching()
    • validate_regression_adjustment()
    • validate_instrumental_variable()
    • validate_difference_in_differences()
    • validate_regression_discontinuity()
    • validate_backdoor_adjustment()
    • recommend_alternative()
  • causal_agent.components.output_formatter module
    • format_output()
  • causal_agent.components.query_interpreter module
    • infer_treatment_variable_type()
    • determine_treatment_reference_level()
    • identify_interaction_term()
    • interpret_query()
    • compute_smd()
  • causal_agent.components.state_manager module
    • create_workflow_state_update()
• causal_agent.tools package
  • input_parser_tool()
  • dataset_analyzer_tool()
  • query_interpreter_tool()
  • method_selector_tool()
  • method_validator_tool()
  • method_executor_tool()
  • explanation_generator_tool()
  • output_formatter_tool()
  • Submodules
  • causal_agent.tools.data_analyzer module
    • DataAnalyzer
  • causal_agent.tools.dataset_analyzer_tool module
    • dataset_analyzer_tool()
  • causal_agent.tools.explanation_generator_tool module
    • explanation_generator_tool()
  • causal_agent.tools.input_parser_tool module
    • input_parser_tool()
  • causal_agent.tools.method_executor_tool module
    • method_executor_tool()
  • causal_agent.tools.method_selector_tool module
    • method_selector_tool()
  • causal_agent.tools.method_validator_tool module
    • extract_properties_from_inputs()
    • method_validator_tool()
  • causal_agent.tools.output_formatter_tool module
    • output_formatter_tool()
  • causal_agent.tools.query_interpreter_tool module
    • query_interpreter_tool()
• causal_agent.utils package
  • Submodules
  • causal_agent.utils.agent module
  • causal_agent.utils.llm_helpers module
    • call_llm_with_json_output()
    • process_llm_response()
    • get_columns_info()
    • analyze_dataset_for_method()
    • llm_identify_temporal_and_unit_vars()

Causal Inference Methods

• causal_agent.methods package
  • CausalMethod
    • CausalMethod.validate_assumptions()
    • CausalMethod.estimate_effect()
    • CausalMethod.generate_code()
    • CausalMethod.explain()
  • psm_estimate_effect()
  • psw_estimate_effect()
  • iv_estimate_effect()
  • did_estimate_effect()
  • rdd_estimate_effect()
  • dim_estimate_effect()
  • lr_estimate_effect()
  • ba_estimate_effect()
  • estimate_effect_gps()
  • Submodules
  • causal_agent.methods.causal_method module
    • CausalMethod
  • causal_agent.methods.utils module
    • check_binary_treatment()
    • calculate_standardized_differences()
    • check_overlap()
    • plot_propensity_overlap()
    • plot_covariate_balance()
    • check_temporal_structure()
    • check_for_discontinuities()
    • find_potential_instruments()
    • test_parallel_trends()
    • preprocess_data()
    • check_collinearity()
  • Subpackages
    • causal_agent.methods.backdoor_adjustment package
    • causal_agent.methods.diff_in_means package
    • causal_agent.methods.generalized_propensity_score package
    • causal_agent.methods.instrumental_variable package
    • causal_agent.methods.linear_regression package
    • causal_agent.methods.propensity_score package
    • causal_agent.methods.regression_discontinuity package

Core Modules

causal_agent

Main entry point and high-level interface for causal analysis.

components

Core analysis components including dataset analysis, method selection, and result interpretation.

methods

Implementation of all causal inference methods organized by category.

tools

Analysis tools and utilities for data processing and validation.

utils

Helper functions and utilities used throughout the codebase.

Auto-Generated Documentation

This API reference is automatically generated from the source code using Sphinx autodoc. The documentation includes:

• Function signatures with parameter types and return values

• Detailed docstrings with usage examples

• Cross-references to related functions and classes

• Source code links for implementation details

Navigation

• Use the sidebar to navigate between modules

• Click on class or function names for detailed documentation

• Use the search function to find specific APIs

• Follow cross-references to explore related functionality

Code Examples

Each API entry includes usage examples where appropriate. For more comprehensive examples, see:

• Code Examples - Focused code examples

• Interactive Notebooks - Interactive tutorials

• Case Studies - Complete case studies