methods_appendix
Turn fitted statistical results into a referee-grade Methods and Formulas appendix, including diagnostics, assumptions, and citations in LaTeX, Markdown, or plain text.
Instructions
Generate a referee-grade Methods and Formulas appendix for results.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| detail | No | Payload depth: 'minimal' (~150 tokens) for sub-step calls where only the point estimate is needed; 'standard' (~1K tokens) for diagnostics + coefficient table; 'agent' (~2K tokens, default) adds violations / next_steps / suggested_functions so the LLM can plan its next call without another round-trip. | agent |
| format | No | Output format. ``"latex"`` emits ``\subsection*`` blocks with display math; ``"markdown"`` emits ``###`` headings with ``$$`` math; ``"text"`` emits a plain-text rendering. | latex |
| results | Yes | One or more fitted result objects exposing ``method`` / ``model_info`` / ``cite``. | |
| as_handle | No | If true, cache the fitted result on the server and return result_id + result_uri alongside the JSON payload so a subsequent tools/call can chain without re-running. | |
| data_path | No | Absolute path or URL to a data file. Supported: .csv / .tsv / .txt (delimited), .parquet / .pq, .feather / .arrow, .xlsx / .xls, .dta (Stata), .json / .jsonl. Schemes: file://, s3://, gs://, https://. | |
| result_id | No | Optional handle to a previously-fitted result (returned by an earlier call when as_handle=true). Tools that operate on a fitted object accept this in place of re-supplying data_path + columns. | |
| data_columns | No | Optional column projection. Parquet/Feather/Stata loaders honour this for fast partial reads. | |
| data_sample_n | No | Optional uniform random subsample size (seed=0, deterministic) — useful on huge panels. | |
| include_citation | No | Append the APA-style reference from ``result.cite()``. | |
| include_provenance | No | Append a one-line provenance trace (StatsPAI version + estimator identity + methods-spec key) -- the "exact code path" leg of the formula / citation / code-path traceability triple. | |
| include_assumptions | No | Include the identifying-assumptions list. | |
| include_diagnostics | No | Include the inference block (SE method, clustering, bandwidth, F, CI). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||