# reuters-dataset

> 🗞️ A tool for downloading and parsing Reuters-21578. These are a collection of documents that appeared on Reuters newswire back in 1987.

Latest version **0.0.3** (published 2020-02-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install reuters-dataset
pnpm add reuters-dataset
yarn add reuters-dataset
bun add reuters-dataset
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2020-02-12 |
| First published | 2020-01-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 16 KB |
| Known vulnerabilities | 0 (+14 in 2 direct dependencies) |
| Install scripts | no |
| Author | Alex Thomas |
| Maintainers | cawfree |

## Links

- npm: https://www.npmjs.com/package/reuters-dataset
- Repository: https://github.com/cawfree/reuters-dataset
- npm.io page: https://npm.io/package/reuters-dataset

## Dependencies (3)

- [tar](https://npm.io/package/tar.md) ^5.0.5
- [moment](https://npm.io/package/moment.md) ^2.24.0
- [xml2js](https://npm.io/package/xml2js.md) ^0.4.23

## Recent versions

- 0.0.3 (latest) — 2020-02-12
- 0.0.2 — 2020-02-12
- 0.0.1 — 2020-01-12

## README

# reuters-dataset
🗞️ A tool for downloading and parsing Reuters-21578. These are a collection of documents that appeared on Reuters newswire back in 1987.

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

#### 🔥 Features
  - Asynchronously caches the full dataset to your temporary directory.
    - This reduces your project size.
  - Prettifies the results.
    - Uses proper JSON naming conventions and common-sense values.

## 🚀 Getting Started

Using [`npm`]():

```bash
npm install --save reuters-dataset
```

Using [`yarn`]():

```bash
yarn add reuters-dataset
```

## ✍️ Usage

```javascript
import getReutersDataset from 'reuters-dataset';

(
  async () => {
    const { exchanges, orgs, people, places, topics, articles } = await getReutersDataset();
  }
)();

```

## 📌 Example

```json
{
  "$": {
    "topics": true,
    "lewissplit": "TRAIN",
    "cgisplit": "TRAINING-SET",
    "oldid": "5544",
    "newid": "1"
  },
  "topics": ["cocoa"],
  "places": ["el-salvador", "usa", "uruguay"],
  "people": [],
  "orgs": [],
  "exchanges": [],
  "companies": [],
  "text": {
    "title": "BAHIA COCOA REVIEW",
    "dateline": "SALVADOR, Feb 26 -",
    "body": "Showers continued throughout [...]"
  },
  "date": "1987-02-26T15:01:01.790Z"
}
```

## ✌️ License
[MIT](https://opensource.org/licenses/MIT)

<p align="center">
  <a href="https://www.buymeacoffee.com/cawfree">
    <img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy @cawfree a coffee" width="232" height="50" />
  </a>
</p>

---
_Source: https://npm.io/package/reuters-dataset · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._