cp

corpora-project

A tool to grab the latest Corpora Project data locally and access it.

Showing:

Popularity

Downloads/wk

23

Maintenance

No Maintenance Data Available

Package

Dependencies

1

Size (min+gzip)

0.5KB

License

Type Definitions

Tree-Shakeable

No?

Categories

Readme

corpora-project

A tool to grab the latest Corpora Project data locally and access it.

Getting Started

Install the module with: npm install corpora-project

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 for a list of categories (directories) and files.

In more detail:

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.

License

Copyright (c) 2015 Kazemi, Darius
Licensed under the MIT license.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100