> 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/sample-datatable.md).

# sample-datatable

## Description

<mark style="color:purple;">`sample-datatable`</mark> *adaptor samples rows in a datatable.*

Sampling method provided are `first`, `random` or `last`, it will default to `first` if unspecified.

## Inputs

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

**`sampling method`**\
Type: `text`\
Required: No\
The sampling method to be used. Valid values are `first`, `random`, or `last`. If unspecified, defaults to `first`

**`sample size`**\
Type: `text`\
Required: No\
The number of rows to be included in the sample. If unspecified, defaults to `100`

## Outputs

**`sample data`**\
Type: `datatable`\
A datatable with the sampled rows.

## Examples

### Example 1: Default behaviour.

#### Inputs:

`data:`

| id        | country | number |
| --------- | ------- | ------ |
| Bovine    | GB      | 1      |
| Gibbon    | TR      | 1      |
| Orangutan | US      | 0      |
| Gorilla   | IND     | -2     |
| Human     | IND     | 0x     |
| Mouse     | IND     |        |

`sampling method:` *null (empty)*

`sample size:` *null (empty)*

#### Outputs:

`data`:

| id        | country | number |
| --------- | ------- | ------ |
| Bovine    | GB      | 1      |
| Gibbon    | TR      | 1      |
| Orangutan | US      | 0      |
| Gorilla   | IND     | -2     |
| Human     | IND     | 0x     |
| Mouse     | IND     |        |

-> Sampled datatable with default sample size `100`.

### Example 2: Sample datatable with specified sampling method.

#### Inputs:

`data:`

| id        | country | number |
| --------- | ------- | ------ |
| Bovine    | GB      | 1      |
| Gibbon    | TR      | 1      |
| Orangutan | US      | 0      |
| Gorilla   | IND     | -2     |
| Human     | IND     | 0x     |
| Mouse     | IND     |        |

`sampling method:` last

`sample size:` 3

#### Outputs:

`data`:

| id      | country | number |
| ------- | ------- | ------ |
| Gorilla | IND     | -2     |
| Human   | IND     | 0x     |
| Mouse   | IND     |        |

-> Sampled datatable with sample size `3` and sampling method `last`.

## Use case

* Create smaller datasets for testing downsteam applications before using a large dataset.