Module for creating a keyword array from a string and excluding stop words.
npm install keyword-extractor
A simple NPM package for extracting _keywords_ from a string by
removing stopwords.
``sh`
$ npm install keyword-extractor
To run the test suite, first install the development dependencies by running the following command within the package's
directory.
`sh`
$ npm install
To execute the package's tests, run:
` sh`
$ make test
`javascript
// include the Keyword Extractor
const 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
*/
const sentence =
"President Obama woke up Monday facing a Congressional defeat that many in both parties believed could hobble his presidency."
// Extract the keywords
const extraction_result =
keyword_extractor.extract(sentence,{
language:"english",
remove_digits: true,
return_changed_case:true,
remove_duplicates: false
});
/*
extraction result is:
[
"president",
"obama",
"woke",
"monday",
"facing",
"congressional",
"defeat",
"parties",
"believed",
"hobble",
"presidency"
]
*/
``
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. ISO 639-1 codes and verbose names | _ar_, _cs_, _da_, _de_, _en_, _es_, _fa_, _fr_, _gl_, _it_, _ko_, _nl_, _pl_, _pt_, _ro_, _ru_, _sv_, _tr_, _vi_, _arabic_, _czech_, _danish_, _dutch_, _english_, _french_, _galician_,_german_, _italian_, _korean_, _persian_, _polish_, _portuguese_, _romanian_, _russian_,_spanish_, _swedish_, _turkish_, _vietnam_
remove_digits | Removes all digits from the results if set to true (can handle Arabic and Perisan digits too) | _true_ or _false_
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_
return_chained_words | Instead of returning each word separately, join the words that were originally together. Setting the value to _true_ will join the words, if _false_ the results will be splitted on each array element. | _true_ or _false_
remove_duplicates | Removes the duplicate keywords | _true_ , _false_ (defaults to _false_ )
return_max_ngrams | Returns keywords that are ngrams with size 0-_integer_ | _integer_ , _false_ (defaults to _false_ )
The initial stopwords lists are taken from the following sources:
- English [http://www.ai.mit.edu/projects/jmlr/papers/volume5/lewis04a/a11-smart-stop-list/english.stop]
- Spanish [https://stop-words.googlecode.com/svn/trunk/stop-words/stop-words/stop-words-spanish.txt]
- Turkish [https://github.com/ahmetax/trstop]