@thedatagrid/data/README.md

Sample datasets for TheDataGrid demos and examples

# @thedatagrid/data

Sample datasets for TheDataGrid demos and examples.

## Installation

```bash
npm install @thedatagrid/data
```

## Usage

### ES Modules

```javascript
import { olympics_1k, olympics_10k, olympics_50k } from '@thedatagrid/data';

// Use the datasets
console.log(olympics_1k.length); // ~1,000 records
console.log(olympics_10k.length); // ~10,000 records  
console.log(olympics_50k.length); // ~50,000 records
```

### Default Import

```javascript
import olympicsData from '@thedatagrid/data';

// Access datasets
const { olympics_1k, olympics_10k, olympics_50k } = olympicsData;
```

## Direct file imports

You can also import the JSON files directly if you prefer:

```javascript
import olympics_1k from '@thedatagrid/data/olympics_1k.json' assert { type: 'json' };
import olympics_10k from '@thedatagrid/data/olympics_10k.json' assert { type: 'json' };
import olympics_50k from '@thedatagrid/data/olympics_50k.json' assert { type: 'json' };
```

or

```js
import olympics_1k from '@thedatagrid/data/olympics_1k'
import olympics_10k from '@thedatagrid/data/olympics_10k'
import olympics_50k from '@thedatagrid/data/olympics_50k'
```

This approach is useful when you only need a specific dataset and want to avoid importing all three.



## Datasets

### Olympics Data

The package includes three Olympic Games datasets with varying sizes:

- **olympics_1k**: ~1,000 Olympic records
- **olympics_10k**: ~10,000 Olympic records  
- **olympics_50k**: ~50,000 Olympic records

Each record contains the following fields:

- `Name`: Athlete's name
- `Sex`: Gender (M/F)
- `Team`: Country/team name
- `NOC`: National Olympic Committee code
- `Year`: Olympic year
- `Season`: Summer/Winter
- `City`: Host city
- `Sport`: Sport category
- `Event`: Specific event
- `Medal`: Medal won (Gold/Silver/Bronze)

## Example with TheDataGrid

```javascript
import { AgGridReact } from 'ag-grid-react';
import { olympics_1k } from '@thedatagrid/data';

function OlympicsGrid() {
  const columnDefs = [
    { field: 'Name' },
    { field: 'Sex' },
    { field: 'Team' },
    { field: 'Year' },
    { field: 'Sport' },
    { field: 'Medal' }
  ];

  return (
    <AgGridReact
      columnDefs={columnDefs}
      rowData={olympics_1k}
      pagination={true}
      paginationPageSize={20}
    />
  );
}
```

## License

MIT