corpora-project's Introduction

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.