> For the complete documentation index, see [llms.txt](https://cgps.gitbook.io/data-flo/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cgps.gitbook.io/data-flo/reference-guide/summarise-datatable.md).

# summarise-datatable

## Description

<mark style="color:purple;">`summarise-datatable`</mark> *adaptor summarises information about specified columns in a datatable.*

## Inputs

**`data`**\
Type: `datatable`\
Required: Yes\
The datatable to be summarised.

**`columns`**\
Type: `list`\
Required: No\
A list of columns to be summarised. If unspecified, all columns will be summarised.

## Outputs

**`summary`**\
Type: `datatable`\
A datatable containing summarised information about each column.

## Examples

### Example 1: Default behaviour.

#### Inputs:

`data`:

| id | code | name           |
| -- | ---- | -------------- |
| 1  | GB   | United Kingdom |
| 2  | TR   | Turkey         |
| 3  | US   | United States  |
| 4  | IND  | India          |
| 5  | IND  | India          |
| 6  | us   | United States  |

`columns`: *null(empty)*

#### Outputs:

`summary`:

<table><thead><tr><th>Column</th><th>Type</th><th width="185">Missing%(out of 6)</th><th width="153">Unique values</th><th>Mean</th></tr></thead><tbody><tr><td>id</td><td>number</td><td>0.0%(0)</td><td>6</td><td>3.5</td></tr><tr><td>code</td><td>string</td><td>0.0%(0)</td><td>5</td><td></td></tr><tr><td>name</td><td>string</td><td>0.0%(0)</td><td>4</td><td></td></tr></tbody></table>

-> Summarised information about the entire datatable.