panelbox 0.2.0__py3-none-any.whl

panelbox/templates/validation/interactive/partials/overview.html

@@ -0,0 +1,146 @@
+<section class="report-section">
+    <h3 class="section-subtitle">Model Information</h3>
+
+    <div class="info-grid">
+        <div class="info-item">
+            <span class="info-label">Model Type:</span>
+            <span class="info-value">{{ model_info.model_type }}</span>
+        </div>
+
+        {% if model_info.formula %}
+        <div class="info-item">
+            <span class="info-label">Formula:</span>
+            <code class="info-value">{{ model_info.formula }}</code>
+        </div>
+        {% endif %}
+
+        <div class="info-item">
+            <span class="info-label">Observations:</span>
+            <span class="info-value">{{ model_info.nobs_formatted or model_info.nobs }}</span>
+        </div>
+
+        {% if model_info.n_entities %}
+        <div class="info-item">
+            <span class="info-label">Entities:</span>
+            <span class="info-value">{{ model_info.n_entities_formatted or model_info.n_entities }}</span>
+        </div>
+        {% endif %}
+
+        {% if model_info.n_periods %}
+        <div class="info-item">
+            <span class="info-label">Time Periods:</span>
+            <span class="info-value">{{ model_info.n_periods_formatted or model_info.n_periods }}</span>
+        </div>
+        {% endif %}
+
+        {% if model_info.balanced %}
+        <div class="info-item">
+            <span class="info-label">Panel Type:</span>
+            <span class="info-value">
+                {% if model_info.balanced %}Balanced{% else %}Unbalanced{% endif %}
+            </span>
+        </div>
+        {% endif %}
+    </div>
+</section>
+
+<section class="report-section mt-6">
+    <h3 class="section-subtitle">Tests by Category</h3>
+
+    <div class="grid grid-cols-2 gap-4">
+        <!-- Specification Tests -->
+        <div class="test-category-card">
+            <h4 class="test-category-title">Specification Tests</h4>
+            <div class="test-category-count">
+                {{ summary.failed_by_category.specification }} /
+                {{ tests|selectattr('category', 'equalto', 'Specification')|list|length }} failed
+            </div>
+            <div class="test-category-status">
+                {% if summary.failed_by_category.specification == 0 %}
+                <span class="badge badge-success">All Passed</span>
+                {% else %}
+                <span class="badge badge-danger">Issues Detected</span>
+                {% endif %}
+            </div>
+        </div>
+
+        <!-- Serial Correlation Tests -->
+        <div class="test-category-card">
+            <h4 class="test-category-title">Serial Correlation</h4>
+            <div class="test-category-count">
+                {{ summary.failed_by_category.serial }} /
+                {{ tests|selectattr('category', 'equalto', 'Serial Correlation')|list|length }} failed
+            </div>
+            <div class="test-category-status">
+                {% if summary.failed_by_category.serial == 0 %}
+                <span class="badge badge-success">All Passed</span>
+                {% else %}
+                <span class="badge badge-danger">Issues Detected</span>
+                {% endif %}
+            </div>
+        </div>
+
+        <!-- Heteroskedasticity Tests -->
+        <div class="test-category-card">
+            <h4 class="test-category-title">Heteroskedasticity</h4>
+            <div class="test-category-count">
+                {{ summary.failed_by_category.heteroskedasticity }} /
+                {{ tests|selectattr('category', 'equalto', 'Heteroskedasticity')|list|length }} failed
+            </div>
+            <div class="test-category-status">
+                {% if summary.failed_by_category.heteroskedasticity == 0 %}
+                <span class="badge badge-success">All Passed</span>
+                {% else %}
+                <span class="badge badge-danger">Issues Detected</span>
+                {% endif %}
+            </div>
+        </div>
+
+        <!-- Cross-Sectional Dependence Tests -->
+        <div class="test-category-card">
+            <h4 class="test-category-title">Cross-Sectional Dependence</h4>
+            <div class="test-category-count">
+                {{ summary.failed_by_category.cross_sectional }} /
+                {{ tests|selectattr('category', 'equalto', 'Cross-Sectional Dependence')|list|length }} failed
+            </div>
+            <div class="test-category-status">
+                {% if summary.failed_by_category.cross_sectional == 0 %}
+                <span class="badge badge-success">All Passed</span>
+                {% else %}
+                <span class="badge badge-danger">Issues Detected</span>
+                {% endif %}
+            </div>
+        </div>
+    </div>
+</section>
+
+<section class="report-section mt-6">
+    <h3 class="section-subtitle">Quick Summary</h3>
+
+    {% if summary.has_issues %}
+    <div class="summary-box summary-box-warning">
+        <h4>Issues Detected</h4>
+        <p>Your model has failed {{ summary.total_failed }} validation test(s). Review the detailed results and recommendations to address these issues.</p>
+
+        <ul class="mt-3">
+            {% if summary.failed_by_category.specification > 0 %}
+            <li><strong>Specification:</strong> {{ summary.failed_by_category.specification }} test(s) failed</li>
+            {% endif %}
+            {% if summary.failed_by_category.serial > 0 %}
+            <li><strong>Serial Correlation:</strong> {{ summary.failed_by_category.serial }} test(s) failed</li>
+            {% endif %}
+            {% if summary.failed_by_category.heteroskedasticity > 0 %}
+            <li><strong>Heteroskedasticity:</strong> {{ summary.failed_by_category.heteroskedasticity }} test(s) failed</li>
+            {% endif %}
+            {% if summary.failed_by_category.cross_sectional > 0 %}
+            <li><strong>Cross-Sectional Dependence:</strong> {{ summary.failed_by_category.cross_sectional }} test(s) failed</li>
+            {% endif %}
+        </ul>
+    </div>
+    {% else %}
+    <div class="summary-box summary-box-success">
+        <h4>All Tests Passed</h4>
+        <p>Your panel data model has successfully passed all {{ summary.total_tests }} validation tests. The model specification appears appropriate and the data shows no major violations of panel data assumptions.</p>
+    </div>
+    {% endif %}
+</section>

panelbox/templates/validation/interactive/partials/recommendations.html

@@ -0,0 +1,101 @@
+<section class="report-section">
+    <h3 class="section-subtitle">Recommendations</h3>
+
+    <p class="text-muted mb-6">
+        Based on the validation test results, here are specific recommendations to address detected issues.
+        Each recommendation includes actionable suggestions to improve your panel data model.
+    </p>
+
+    {% for rec in recommendations %}
+    <div class="recommendation-card recommendation-{{ rec.severity }} mb-6">
+        <div class="recommendation-header">
+            <div class="recommendation-category">
+                <span class="recommendation-icon">
+                    {% if rec.severity == 'critical' %}⚠️{% elif rec.severity == 'high' %}🔴{% elif rec.severity == 'medium' %}🟡{% else %}🔵{% endif %}
+                </span>
+                <span class="recommendation-category-text">{{ rec.category }}</span>
+            </div>
+            <span class="badge badge-{{ rec.severity }}">{{ rec.severity|upper }}</span>
+        </div>
+
+        <div class="recommendation-body">
+            <h4 class="recommendation-title">{{ rec.issue }}</h4>
+
+            <div class="recommendation-tests">
+                <strong>Failed Tests:</strong>
+                <ul class="test-list">
+                    {% for test in rec.tests %}
+                    <li>{{ test }}</li>
+                    {% endfor %}
+                </ul>
+            </div>
+
+            <div class="recommendation-suggestions">
+                <strong>Suggested Actions:</strong>
+                <ol class="suggestion-list">
+                    {% for suggestion in rec.suggestions %}
+                    <li>{{ suggestion }}</li>
+                    {% endfor %}
+                </ol>
+            </div>
+        </div>
+    </div>
+    {% endfor %}
+
+    <!-- General Best Practices -->
+    <div class="info-box mt-8">
+        <h4 class="info-box-title">General Best Practices</h4>
+        <div class="info-box-content">
+            <ul class="info-box-list">
+                <li>
+                    <strong>Robust Standard Errors:</strong>
+                    Always consider using robust standard errors (clustered, HAC, or Driscoll-Kraay) to
+                    account for potential violations of i.i.d. assumptions.
+                </li>
+                <li>
+                    <strong>Specification Testing:</strong>
+                    Run specification tests (Hausman, Mundlak) to validate your choice between Fixed Effects
+                    and Random Effects models.
+                </li>
+                <li>
+                    <strong>Time Effects:</strong>
+                    Consider including time fixed effects to control for common shocks and time trends that
+                    affect all entities.
+                </li>
+                <li>
+                    <strong>Model Diagnostics:</strong>
+                    Examine residual plots and influential observations to identify outliers and
+                    potential model misspecification.
+                </li>
+                <li>
+                    <strong>Theory-Driven Specification:</strong>
+                    Base your model specification on economic theory and prior research, not just
+                    statistical tests.
+                </li>
+            </ul>
+        </div>
+    </div>
+
+    <!-- References -->
+    <div class="references-box mt-6">
+        <h4 class="references-title">Further Reading</h4>
+        <ul class="references-list">
+            <li>
+                Wooldridge, J. M. (2010). <em>Econometric Analysis of Cross Section and Panel Data</em> (2nd ed.).
+                MIT Press.
+            </li>
+            <li>
+                Baltagi, B. H. (2021). <em>Econometric Analysis of Panel Data</em> (6th ed.).
+                Springer.
+            </li>
+            <li>
+                Cameron, A. C., & Trivedi, P. K. (2005). <em>Microeconometrics: Methods and Applications</em>.
+                Cambridge University Press.
+            </li>
+            <li>
+                Pesaran, M. H. (2015). Testing Weak Cross-Sectional Dependence in Large Panels.
+                <em>Econometric Reviews</em>, 34(6-10), 1089-1117.
+            </li>
+        </ul>
+    </div>
+</section>

panelbox/templates/validation/interactive/partials/test_results.html

@@ -0,0 +1,231 @@
+<section class="report-section">
+    <h3 class="section-subtitle">Detailed Test Results</h3>
+
+    <p class="text-muted mb-4">
+        This table shows detailed results for all {{ tests|length }} validation tests performed on your panel data model.
+        Tests marked as "REJECT" indicate potential issues that may require attention.
+    </p>
+
+    <!-- Specification Tests -->
+    {% set spec_tests = tests|selectattr('category', 'equalto', 'Specification')|list %}
+    {% if spec_tests %}
+    <div class="test-group mb-6">
+        <h4 class="test-group-title">Specification Tests</h4>
+        <p class="test-group-description">
+            Tests for model specification, including choice between Fixed Effects and Random Effects.
+        </p>
+
+        <div class="table-container">
+            <table class="data-table">
+                <thead>
+                    <tr>
+                        <th>Test Name</th>
+                        <th>Statistic</th>
+                        <th>P-value</th>
+                        <th>DF</th>
+                        <th>Result</th>
+                        <th>Conclusion</th>
+                    </tr>
+                </thead>
+                <tbody>
+                    {% for test in spec_tests %}
+                    <tr class="test-row test-row-{{ test.result_class }}">
+                        <td class="font-medium">{{ test.name }}</td>
+                        <td>{{ test.statistic_formatted }}</td>
+                        <td>
+                            {{ test.pvalue_formatted }}
+                            {% if test.significance %}
+                            <span class="significance-stars">{{ test.significance }}</span>
+                            {% endif %}
+                        </td>
+                        <td>{{ test.df or 'N/A' }}</td>
+                        <td>
+                            <span class="badge badge-{{ test.result_class }}">
+                                {{ test.result }}
+                            </span>
+                        </td>
+                        <td class="text-sm">{{ test.conclusion }}</td>
+                    </tr>
+                    {% endfor %}
+                </tbody>
+            </table>
+        </div>
+    </div>
+    {% endif %}
+
+    <!-- Serial Correlation Tests -->
+    {% set serial_tests = tests|selectattr('category', 'equalto', 'Serial Correlation')|list %}
+    {% if serial_tests %}
+    <div class="test-group mb-6">
+        <h4 class="test-group-title">Serial Correlation Tests</h4>
+        <p class="test-group-description">
+            Tests for autocorrelation in residuals across time periods.
+        </p>
+
+        <div class="table-container">
+            <table class="data-table">
+                <thead>
+                    <tr>
+                        <th>Test Name</th>
+                        <th>Statistic</th>
+                        <th>P-value</th>
+                        <th>DF</th>
+                        <th>Result</th>
+                        <th>Conclusion</th>
+                    </tr>
+                </thead>
+                <tbody>
+                    {% for test in serial_tests %}
+                    <tr class="test-row test-row-{{ test.result_class }}">
+                        <td class="font-medium">{{ test.name }}</td>
+                        <td>{{ test.statistic_formatted }}</td>
+                        <td>
+                            {{ test.pvalue_formatted }}
+                            {% if test.significance %}
+                            <span class="significance-stars">{{ test.significance }}</span>
+                            {% endif %}
+                        </td>
+                        <td>{{ test.df or 'N/A' }}</td>
+                        <td>
+                            <span class="badge badge-{{ test.result_class }}">
+                                {{ test.result }}
+                            </span>
+                        </td>
+                        <td class="text-sm">{{ test.conclusion }}</td>
+                    </tr>
+                    {% endfor %}
+                </tbody>
+            </table>
+        </div>
+    </div>
+    {% endif %}
+
+    <!-- Heteroskedasticity Tests -->
+    {% set het_tests = tests|selectattr('category', 'equalto', 'Heteroskedasticity')|list %}
+    {% if het_tests %}
+    <div class="test-group mb-6">
+        <h4 class="test-group-title">Heteroskedasticity Tests</h4>
+        <p class="test-group-description">
+            Tests for non-constant variance in residuals.
+        </p>
+
+        <div class="table-container">
+            <table class="data-table">
+                <thead>
+                    <tr>
+                        <th>Test Name</th>
+                        <th>Statistic</th>
+                        <th>P-value</th>
+                        <th>DF</th>
+                        <th>Result</th>
+                        <th>Conclusion</th>
+                    </tr>
+                </thead>
+                <tbody>
+                    {% for test in het_tests %}
+                    <tr class="test-row test-row-{{ test.result_class }}">
+                        <td class="font-medium">{{ test.name }}</td>
+                        <td>{{ test.statistic_formatted }}</td>
+                        <td>
+                            {{ test.pvalue_formatted }}
+                            {% if test.significance %}
+                            <span class="significance-stars">{{ test.significance }}</span>
+                            {% endif %}
+                        </td>
+                        <td>{{ test.df or 'N/A' }}</td>
+                        <td>
+                            <span class="badge badge-{{ test.result_class }}">
+                                {{ test.result }}
+                            </span>
+                        </td>
+                        <td class="text-sm">{{ test.conclusion }}</td>
+                    </tr>
+                    {% endfor %}
+                </tbody>
+            </table>
+        </div>
+    </div>
+    {% endif %}
+
+    <!-- Cross-Sectional Dependence Tests -->
+    {% set cd_tests = tests|selectattr('category', 'equalto', 'Cross-Sectional Dependence')|list %}
+    {% if cd_tests %}
+    <div class="test-group mb-6">
+        <h4 class="test-group-title">Cross-Sectional Dependence Tests</h4>
+        <p class="test-group-description">
+            Tests for correlation across entities (cross-sectional units).
+        </p>
+
+        <div class="table-container">
+            <table class="data-table">
+                <thead>
+                    <tr>
+                        <th>Test Name</th>
+                        <th>Statistic</th>
+                        <th>P-value</th>
+                        <th>DF</th>
+                        <th>Result</th>
+                        <th>Conclusion</th>
+                    </tr>
+                </thead>
+                <tbody>
+                    {% for test in cd_tests %}
+                    <tr class="test-row test-row-{{ test.result_class }}">
+                        <td class="font-medium">{{ test.name }}</td>
+                        <td>{{ test.statistic_formatted }}</td>
+                        <td>
+                            {{ test.pvalue_formatted }}
+                            {% if test.significance %}
+                            <span class="significance-stars">{{ test.significance }}</span>
+                            {% endif %}
+                        </td>
+                        <td>{{ test.df or 'N/A' }}</td>
+                        <td>
+                            <span class="badge badge-{{ test.result_class }}">
+                                {{ test.result }}
+                            </span>
+                        </td>
+                        <td class="text-sm">{{ test.conclusion }}</td>
+                    </tr>
+                    {% endfor %}
+                </tbody>
+            </table>
+        </div>
+    </div>
+    {% endif %}
+
+    <!-- Legend -->
+    <div class="legend-box mt-6">
+        <h4 class="legend-title">Result Legend</h4>
+        <div class="legend-items">
+            <div class="legend-item">
+                <span class="badge badge-accept">ACCEPT</span>
+                <span class="legend-text">Test passed - no issues detected</span>
+            </div>
+            <div class="legend-item">
+                <span class="badge badge-reject">REJECT</span>
+                <span class="legend-text">Test failed - potential issue detected</span>
+            </div>
+        </div>
+
+        <h4 class="legend-title mt-4">Significance Levels</h4>
+        <div class="legend-items">
+            <div class="legend-item">
+                <span class="significance-stars">***</span>
+                <span class="legend-text">p < 0.001</span>
+            </div>
+            <div class="legend-item">
+                <span class="significance-stars">**</span>
+                <span class="legend-text">p < 0.01</span>
+            </div>
+            <div class="legend-item">
+                <span class="significance-stars">*</span>
+                <span class="legend-text">p < 0.05</span>
+            </div>
+            <div class="legend-item">
+                <span class="significance-stars">.</span>
+                <span class="legend-text">p < 0.1</span>
+            </div>
+        </div>
+    </div>
+</section>

panelbox/utils/formatting.py

@@ -0,0 +1,172 @@
+"""
+Formatting utilities for output display.
+
+This module provides functions for formatting statistical output
+in a readable, publication-quality format.
+"""
+
+from typing import Union
+
+
+def format_pvalue(pvalue: float, digits: int = 4) -> str:
+    """
+    Format p-value for display.
+
+    Parameters
+    ----------
+    pvalue : float
+        p-value
+    digits : int, default=4
+        Number of decimal places
+
+    Returns
+    -------
+    str
+        Formatted p-value string
+
+    Examples
+    --------
+    >>> format_pvalue(0.0001)
+    '<0.0001'
+    >>> format_pvalue(0.1234)
+    '0.1234'
+    """
+    threshold = 10 ** (-digits)
+
+    if pvalue < threshold:
+        return f"<{threshold:.{digits}f}"
+    else:
+        return f"{pvalue:.{digits}f}"
+
+
+def format_number(
+    value: Union[int, float],
+    decimals: int = 4,
+    width: int = 10
+) -> str:
+    """
+    Format number for tabular display.
+
+    Parameters
+    ----------
+    value : int or float
+        Number to format
+    decimals : int, default=4
+        Number of decimal places
+    width : int, default=10
+        Total width of formatted string
+
+    Returns
+    -------
+    str
+        Formatted number string
+    """
+    if isinstance(value, int):
+        return f"{value:>{width},}"
+    else:
+        return f"{value:>{width}.{decimals}f}"
+
+
+def significance_stars(pvalue: float) -> str:
+    """
+    Return significance stars based on p-value.
+
+    Parameters
+    ----------
+    pvalue : float
+        p-value
+
+    Returns
+    -------
+    str
+        Significance stars
+
+    Examples
+    --------
+    >>> significance_stars(0.0001)
+    '***'
+    >>> significance_stars(0.01)
+    '**'
+    >>> significance_stars(0.04)
+    '*'
+    >>> significance_stars(0.08)
+    '.'
+    >>> significance_stars(0.20)
+    ''
+    """
+    if pvalue < 0.001:
+        return '***'
+    elif pvalue < 0.01:
+        return '**'
+    elif pvalue < 0.05:
+        return '*'
+    elif pvalue < 0.10:
+        return '.'
+    else:
+        return ''
+
+
+def format_coefficient_table(
+    params,
+    std_errors,
+    tvalues,
+    pvalues,
+    conf_int=None
+) -> str:
+    """
+    Format coefficient table for display.
+
+    Parameters
+    ----------
+    params : pd.Series
+        Coefficients
+    std_errors : pd.Series
+        Standard errors
+    tvalues : pd.Series
+        t-statistics
+    pvalues : pd.Series
+        p-values
+    conf_int : pd.DataFrame, optional
+        Confidence intervals
+
+    Returns
+    -------
+    str
+        Formatted table
+    """
+    lines = []
+
+    # Header
+    if conf_int is not None:
+        lines.append(
+            f"{'Variable':<15} {'Coef.':<12} {'Std.Err.':<12} {'t':<8} "
+            f"{'P>|t|':<8} {'[0.025':<10} {'0.975]':<10}"
+        )
+    else:
+        lines.append(
+            f"{'Variable':<15} {'Coef.':<12} {'Std.Err.':<12} {'t':<8} {'P>|t|':<8}"
+        )
+
+    lines.append("-" * 78)
+
+    # Rows
+    for var in params.index:
+        coef = params[var]
+        se = std_errors[var]
+        t = tvalues[var]
+        p = pvalues[var]
+        stars = significance_stars(p)
+
+        if conf_int is not None:
+            ci_lower = conf_int.loc[var, 'lower']
+            ci_upper = conf_int.loc[var, 'upper']
+            lines.append(
+                f"{var:<15} {coef:>11.4f} {se:>11.4f} {t:>7.3f} "
+                f"{p:>7.4f} {ci_lower:>9.4f} {ci_upper:>9.4f} {stars}"
+            )
+        else:
+            lines.append(
+                f"{var:<15} {coef:>11.4f} {se:>11.4f} {t:>7.3f} {p:>7.4f} {stars}"
+            )
+
+    return "\n".join(lines)