keyword-extractor

Module for creating a keyword array from a string and excluding stop words.

npm install keyword-extractor
14 downloads in the last week
33 downloads in the last month

Keyword Extractor

A simple NPM package for extracting keywords from a string by removing stopwords.

Installation

$ npm install keyword-extractor

Running tests

To run the test suite, first install the development dependencies by running the following command within the package's directory.

$ npm install

To execute the package's tests, run:

$ make test

Usage of the Module

//  include the Keyword Extractor
var keyword_extractor = require("keyword-extractor");

//  Opening sentence to NY Times Article at
//  http://www.nytimes.com/2013/09/10/world/middleeast/surprise-russian-proposal-catches-obama-between-putin-and-house-republicans.html
var sentence = "President Obama woke up Monday facing a Congressional defeat that many in both parties believed could hobble his presidency."

//  Extract the keywords
var extraction_result = keyword_extractor.extract(sentence,{
                                                                language:"english",
                                                                return_changed_case:true
                                                           });

/*
  extraction result is:

  [
        "president",
        "obama",
        "woke",
        "monday",
        "facing",
        "congressional",
        "defeat",
        "parties",
        "believed",
        "hobble",
        "presidency"
    ]
*/

Options Parameters

The second argument of the extract method is an Object of configuration/processing settings for the extraction.

Parameter Name Description Permitted Values
language The stopwords list to use. english or spanish
return_changed_case The case of the extracted keywords. Setting the value to true will return the results all lower-cased, if false the results will be in the original case. true or false

Credits

The initial stopwords lists are taken from the following sources:

npm loves you