# Heatmap

Generate an x / y heatmap, which uses the number of rows in each x/y bin as a density overlay to a 2-d histogram

## Parameters

| Name         | Type         | Description                                                                                                            | Is Optional |
| ------------ | ------------ | ---------------------------------------------------------------------------------------------------------------------- | ----------- |
| x\_axis      | column       | numeric column to use as the x axis                                                                                    |             |
| y\_axis      | column       | numeric column to use as the y axis                                                                                    |             |
| filters      | filter\_list | Filter logic on one or more columns. Can choose between a simple comparison filter or advanced filter using free text. | True        |
| num\_buckets | value        | max number of buckets to create; defaults to 100                                                                       | True        |

## Example

```python
ds = rasgo.get.dataset(id)

ds2 = ds.heatmap(x_axis='TEMPERATURE',
  y_axis='PRECIPITATION')
ds2.preview()
```

## Source Code

{% embed url="<https://github.com/rasgointelligence/RasgoTransforms/blob/main/rasgotransforms/rasgotransforms/transforms/heatmap/heatmap.sql>" %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.rasgoml.com/rasgo-docs/rasgo-0.1/all-transforms/heatmap.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
