# checks pack

3 nodes, in `noodlelab` and above.

## Checks

(node-checks.expect_in_range)=
### Expect In Range

`checks.expect_in_range`

Expect a number, an array or a column to lie within limits (either may
be left empty). Missing values (NaN) fail unless allowed.

**Inputs**

| Name | Type | Description |
|---|---|---|
| `value` | `Any` |  |
| `minimum` | `float \| None` | Optional. |
| `maximum` | `float \| None` | Optional. |
| `unit` | `str` | The limits' unit, for a quantity Default `''`. |
| `allow_missing` | `bool` | Default `False`. |

**Outputs**

| Name | Type | Description |
|---|---|---|
| `value` | `Any` |  |
| `check` | `Check` |  |

(node-checks.expect_table)=
### Expect Table

`checks.expect_table`

Expect a table to have its columns, no gaps where it matters, a unique
key and a plausible number of rows.

**Inputs**

| Name | Type | Description |
|---|---|---|
| `table` | `DataFrame` |  |
| `columns` | `str` | Columns it must have, comma-separated Default `''`. |
| `complete` | `str` | Columns without missing values (* for all) Default `''`. |
| `unique` | `str` | A column whose values must not repeat Default `''`. |
| `min_rows` | `int` | Default `1`. |
| `max_rows` | `int` | 0: no limit Default `0`. |

**Outputs**

| Name | Type | Description |
|---|---|---|
| `value` | `Any` |  |
| `check` | `Check` |  |

(node-checks.expect_value)=
### Expect Value

`checks.expect_value`

Expect a result to equal a value: typed ("9.81", "9.81 m/s^2", "9.81 ±
0.02") or linked. Passes within the tolerance, or, when either side has an
uncertainty, when |Δ| ≤ k·u(Δ), the standard uncertainty of the difference
(which is √(u₁² + u₂²) when they share no inputs). Complex values are
compared by the modulus of the difference. Arrays are compared element-wise.

**Inputs**

| Name | Type | Description |
|---|---|---|
| `value` | `Any` |  |
| `expected` | `Uncertain` | Default `0.0`. |
| `tolerance` | `float` | Absolute tolerance, in the expected value's unit Default `0.0`. |
| `relative` | `float` | Relative tolerance, in % of the expected value Default `0.0`. |
| `coverage` | `float` | With uncertainties: agree within k combined standard uncertainties Default `2.0`. |

**Outputs**

| Name | Type | Description |
|---|---|---|
| `value` | `Any` |  |
| `check` | `Check` |  |