| 1 | # Keyword Extractor
|
| 2 |
|
| 3 | A simple [NPM package](https://npmjs.org/package/keyword-extractor) for extracting _keywords_ from a string by
|
| 4 | removing stopwords.
|
| 5 |
|
| 6 | ## Installation
|
| 7 |
|
| 8 | ```sh
|
| 9 | $ npm install keyword-extractor
|
| 10 | ```
|
| 11 | ### Install browserify, required for demo (modify sample.js file and browserify after that)
|
| 12 | ```sh
|
| 13 | $ npm install browserify
|
| 14 | $ cd keyword-extractor/demo
|
| 15 | $ browserify sample.js -o bundle.js
|
| 16 | ```
|
| 17 | > [use online documentation for detalied usage](http://browserify.org/)
|
| 18 |
|
| 19 | ## Running tests
|
| 20 |
|
| 21 | To run the test suite, first install the development dependencies by running the following command within the package's
|
| 22 | directory.
|
| 23 |
|
| 24 | ```sh
|
| 25 | $ npm install
|
| 26 | ```
|
| 27 |
|
| 28 | To execute the package's tests, run:
|
| 29 |
|
| 30 | ``` sh
|
| 31 | $ make test
|
| 32 | ```
|
| 33 |
|
| 34 | ## Usage of the Module
|
| 35 |
|
| 36 | ```javascript
|
| 37 | // include the Keyword Extractor
|
| 38 | var keyword_extractor = require("keyword-extractor");
|
| 39 |
|
| 40 | // Opening sentence to NY Times Article at
|
| 41 | // http://www.nytimes.com/2013/09/10/world/middleeast/surprise-russian-proposal-catches-obama-between-putin-and-house-republicans.html
|
| 42 | var sentence = "President Obama woke up Monday facing a Congressional defeat that many in both parties believed could hobble his presidency."
|
| 43 |
|
| 44 | // Extract the keywords
|
| 45 | var extraction_result = keyword_extractor.extract(sentence,{
|
| 46 | language:"english",
|
| 47 | remove_digits: true,
|
| 48 | return_changed_case:true,
|
| 49 | remove_duplicates: false
|
| 50 |
|
| 51 | });
|
| 52 |
|
| 53 | /*
|
| 54 | extraction result is:
|
| 55 |
|
| 56 | [
|
| 57 | "president",
|
| 58 | "obama",
|
| 59 | "woke",
|
| 60 | "monday",
|
| 61 | "facing",
|
| 62 | "congressional",
|
| 63 | "defeat",
|
| 64 | "parties",
|
| 65 | "believed",
|
| 66 | "hobble",
|
| 67 | "presidency"
|
| 68 | ]
|
| 69 | */
|
| 70 | ```
|
| 71 |
|
| 72 | ### Options Parameters
|
| 73 |
|
| 74 | The second argument of the _extract_ method is an Object of configuration/processing settings for the extraction.
|
| 75 |
|
| 76 | Parameter Name | Description | Permitted Values
|
| 77 | ---------------|-------------|-----------------
|
| 78 | language | The stopwords list to use. | _english_, _spanish_, _polish_, _german_, _french_, _italian_, _dutch_, _romanian_, _russian_, _portuguese_, _swedish_,
|
| 79 | remove_digits | Removes all digits from the results if set to true | _true_ or _false_
|
| 80 | 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_
|
| 81 | 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_
|
| 82 | remove_duplicates | Removes the duplicate keywords | _true_ , _false_ (defaults to _false_ )
|
| 83 | return_max_ngrams | Returns keywords that are ngrams with size 0-_integer_ | _integer_ , _false_ (defaults to _false_ )
|
| 84 |
|
| 85 |
|
| 86 | ## Credits
|
| 87 |
|
| 88 | The initial stopwords lists are taken from the following sources:
|
| 89 |
|
| 90 | - English [http://jmlr.org/papers/volume5/lewis04a/a11-smart-stop-list/english.stop]
|
| 91 | - Spanish [https://stop-words.googlecode.com/svn/trunk/stop-words/stop-words/stop-words-spanish.txt]
|