eklem-headline-parser

    3.0.1 • Public • Published

    eklem-headline-parser

    Determines the most relevant keywords in a headline by considering article context. Works for Node.js and the browser. Started as a forked version of TessMyers headline-parser.

    NPM version NPM downloads Build Status JavaScript Style Guide MIT License

    Demo

    Browser demo screenshot Check out the browser demo or have a look at the demo source files.

    Usage

    Common JS

    const headlineParser = require('eklem-headline-parser')
    // headlineParser.findKeywords(headline, body [, cutoff]) now available

    ES Modules

    import headlineParser from 'eklem-headline-parser'
    // headlineParser.findKeywords(headline, body [, cutoff]) now available

    UMD - Script tag method

    <script src="headline-parser.js"></script>
    <script>
    // ehp.findKeywords(headline, body [, cutoff]) now available
    </script>

    Remove noise

    To skip all words with little or no meaning, use a stopword stripping library, i.e. stopword.

    <script src="headline-parser.js"></script>
    <script src="stopword.js"></script>
    <script>
    // ehp.findKeywords(sw.removeStopwords(headline), body [, cutoff])
    </script>

    Calculating some keywords

    const headlineParser = require('eklem-headline-parser')
    const sw = require('stopword')
    
    // Declare variables for your headline and article summary. These have been edited to provide a good example.
    let headline = 'China successfully develops drone defense system'
    
    let body = 'China has tested a self-developed laser defense system against small-scale low-altitude drones, state media said on Sunday. Reportedly, the drone defense is designed to destroy small-scale drones flying within an altitude of 500 meters and at speeds below 50 meters per second. In addition to the drone network, china has developed stealth jets and has built one aircraft carrier.'
    
    // Find the most relevant keywords in the headline, sorted by number of appearances in the body text
    let important_keywords = headline_parser.findKeywords(sw.removeStopwords(headline.split(' ')), body.split(' '), 3);
    
    // => Returns the top three occuring words [ 'drone', 'defence', 'China' ], with 'drone' appearing most often.

    API

    findKeywords() accepts four arguments, of which the last two are optional.

    .findKeywords(headline, body [, cutoff]);
    
    Argument name Description Permitted values
    headline Headline of article Array
    body Context from the article. May be the entire article body, or just a few sample sentences. The more context, the greater the accuracy of the parser. Array
    (optional) cutoff Number of top keywords desired. If left out, the parser will return all keywords sorted by relevance. Integer

    How does it work?

    It's pretty simple. The parser will count how many times a word in a title is repeated in a body text and then sorts those words by how many times each word appears in the article body provided.

    The parser is language agnostic, but for better accuracy, you should use the stopword module to obtain only the words that are not stopwords. For this to happen, you need to define which langauge is used in the text analyzed.

    Some things to note: The module will not count partial appearances of keywords, or compounded keywords. For instance, if one of your headline keywords is ['china'], then neither "China", "china's" or "Indochina" will be counted as an appearance of that keyword.

    Install

    npm i eklem-headline-parser

    DownloadsWeekly Downloads

    19

    Version

    3.0.1

    License

    ISC

    Unpacked Size

    538 kB

    Total Files

    19

    Last publish

    Collaborators

    • eklem