nbreg
Fit negative-binomial count models to overdispersed non-negative outcome data, supporting fixed effects, offsets, and robust standard errors for reliable causal analysis.
Instructions
Fit a negative-binomial count model. Use this for overdispersed non-negative count outcomes; formulas may include explicit fixed effects with 'y ~ x | id' for moderate panels. Validation: certified parity evidence.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| irr | No | Report incidence-rate ratios instead of log coefficients. | |
| 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 |
| offset | No | Column containing a log offset. | |
| robust | No | nonrobust | |
| cluster | No | Column name for cluster-robust SEs. | |
| formula | Yes | R-style formula, e.g. 'count ~ x1 + x2 | id' | |
| exposure | No | Positive exposure column; log(exposure) is used as offset. | |
| 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 | Yes | 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. | |
| dispersion | No | NB2 mean dispersion or NB1 constant dispersion. | mean |
| 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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||