https://github.com/dariusk/corpora-project

This is the NPM package to access the latest corpora data.
https://github.com/dariusk/corpora-project

Last synced: about 1 month ago
JSON representation

This is the NPM package to access the latest corpora data.

• Host: GitHub
• URL: https://github.com/dariusk/corpora-project
• Owner: dariusk
• License: mit
• Created: 2015-02-12T20:22:33.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-02-09T23:37:13.000Z (almost 8 years ago)
• Last Synced: 2024-08-02T05:10:07.887Z (3 months ago)
• Language: JavaScript
• Size: 8.79 KB
• Stars: 5
• Watchers: 3
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-MIT

Awesome Lists containing this project

README

        
# corpora-project

A tool to grab the latest [Corpora Project](https://github.com/dariusk/corpora/) data locally and access it.

## Getting Started

Install the module with: `npm install corpora-project`

```javascript

var corpora = require('corpora-project');

corpora.getFile('animals', 'common');

```

## Documentation

Using the module is pretty easy. If you want to access a corpora file called `nouns.json` in the `words` directory, just call `getCategories('words', 'nouns')`.

See the [Corpora Project](https://github.com/dariusk/corpora/tree/master/data) for a list of categories (directories) and files.

In more detail:

```javascript

var corpora = require('corpora-project');

// List all corpora base directories

corpora.getCategories(); // ["animals", "archetypes", ...]

// List all subdirectories in a directory

corpora.getCategories('words'); // ["literature", "word_clues", ...]

// List all files in a directory

corpora.getFiles('animals'); // ["birds_antarctica", "birds_uk", "common", ...]

// List all files in a subdirectory

corpora.getFiles('words/word_clues'); // ["clues_five", "clues_four", ...]

// Get the data from a file

corpora.getFile('animals', 'common');

// returns this object:

/*

{

  "animals":

    [

      "aardvark",

      "alligator",

      "alpaca",

      //...

      "zebra"

    ]

}

*/

// Get the data from a file in a subdirectory

corpora.getFile('words/word_clues', 'clues_four');

```

## Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

## License

Copyright (c) 2015 Kazemi, Darius  

Licensed under the MIT license.