demean
Apply within-transformation to strip fixed effects from your regressors, producing the adjusted variable and keep mask for reliable causal analysis.
Instructions
Return the within-transformed x and the singleton keep mask. Validation: certified parity evidence.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| x | Yes | Primary running variable, regressor, or feature input for this estimator. | |
| fe | Yes | fe parameter (Union[pd.DataFrame, np.ndarray, None]). | |
| tol | No | Numerical convergence tolerance. | |
| 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 |
| slopes | No | slopes parameter (Optional[Sequence[SlopeSpec]]). | |
| solver | No | solver parameter (str). | map |
| maxiter | No | maxiter parameter (int). | |
| weights | No | Observation weights. | |
| 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. | |
| drop_singletons | No | drop_singletons parameter (bool). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||