estimate
Check the rows, stations, and time span a data selection covers before fetching it, so you can confirm scope and avoid unnecessary downloads.
Instructions
How big a selection is -- rows, stations, time span -- without fetching it. Call this before get_data.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | a variable id from search_variables | |
| end | No | ISO date or datetime, EXCLUSIVE | |
| start | No | ISO date or datetime, inclusive (2025-01-01) | |
| cruise | No | cruise expocodes, a list or a string; ocean observation tables only | |
| lat_max | No | northern edge of a bounding box, degrees north | |
| lat_min | No | southern edge of a bounding box, degrees north | |
| lon_max | No | eastern edge of a bounding box, degrees east | |
| lon_min | No | western edge of a bounding box, degrees east | |
| station | No | station ids -- a list, or one id (or several, comma-separated) as a string; CASE-SENSITIVE: HTM150 (trigram + sampling height) for atmosphere, SE-Htm for FLUXNET sites | |
| apply_qc | No | DEFAULT TRUE: drop the observations the store's recommended quality control rejects; false keeps every observation, flagged ones included | |
| height_max | No | highest sampling height above ground, metres (station series) | |
| height_min | No | lowest sampling height above ground, metres (station series) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| note | No | ||
| rows | Yes | rows the selection holds; None when only an upper bound is known | |
| exact | Yes | ||
| time_max | No | ||
| time_min | No | ||
| est_bytes | No | ||
| n_stations | No | ||
| rows_at_most | No |