User guide

README - Tweeter Analysis Tool

Description :

This software enables to analyse and exploit data from twitter in order to create reports and graphs. The data analysis should enable to provide Tweets' sets, defined by a criterias, and SVG/PNG graphs.

Authors :

Project produced by 4 UTT students within the framework of the teaching unit GL02.
Team “Rocko”.

• Chabrit Quentin
• Nosal Loïck
• François Vincent
• Raymond Thomad

Installation :

In order to make the program work, you need to download the project.

svn checkouk <URI du projet>

Then you must be in the current folder /trunk of the project and write :

 npm install

This line enables to install all the necessary dependencies to make the project work. In order to use npm, Node.js must be installed on your computer.

You also have to install another module in order to create graphs in png. You have to be in the current folder /trunk of the project and write :

 npm install canvas

This line enables to create graphs in png acocording to the function associated.

Commands :

Many commands are offered by the software. They are detailled below.
To make them work, you have to be in folder /trunk
To make them work, Node.js must be installed on your computer.
For the values like this one <valeur>, all the bloc must be replaced by one or many variables of your choice.

Get an interactive menu to launch all the commands :

node . start

Get a detailled list of the available commands

node .

Get detailled information and options on a specific command :

node . <nom de la commande> --help

Get the top 10 of the most retweeted Tweets with a specific hashtag :

node . top10tweetMoreRetweet <hashtag>

Get all the tweets corresponding to a specific hashtag on a given period of time :

node . tweetsSurUnHashtag <hashtag> <dateDébut> <dateFin>

Beginnig date and End date must follow the following example :
"Tue Mar 20 11:33:25 +0000 2018"

For example :

node . tweetsSurUnHashtag EAW18 "Tue Mar 20 11:33:25 +0000 2018" "Sat Mar 24 01:04:22 +0000 2018"

This command will return the number of Tweets by day having the hashtag "EAW18" between 20/03/2018 and 24/03/2018

Get the top 10 of the authors having the most informations about themselves :

node . top10tweetWithInfo

Get the proportion in percentage of Tweets by country :

node . proportionTweetPerCountry

Extract the list of hashtags matching with a reference :

node . hashtagAssociated <hashtag>

Extract the list of Tweets corresponding to specific criterias

Voici les différents critères optionnels que vous pouvez utiliser pour filtrer les tweets :

• --hashtag : filter all the tweets containing this hashtag.
• --keyword : filter all the tweets containing this keyword.
• --author : filter all the tweets written by this author.
• --retweetCount : filter all the tweets containing a minimal number of retweet.
• --country : filter all the Tweets containing the country specified.
• --minDate : filter all the Tweets written after this date (format MM/DD/YYYY ou MM-DD-YYYY).
• --maxDate : filter all the Tweets written before or at this date (format MM/DD/YYYY ou MM-DD-YYYY).

Here is the command to use :

node . searchBy <liste des options ... >

For instance :

node . searchBy --hashtag eaw18 --retweetCount 20 --minDate 03/22/2018

This command enables to get the Tweets containing the hashtag "eaw18", at least retweeted 20 times and written after de 22 march 2018.

Extract the hashtags' list associated to a reference hashtag :

node . hashtagAssociated <hashtag>

Get the top 10 of the authors with the most followers :

node . top10Person

Comments

This software has been developped to correspond to specifications.