Menu

Home

SCATENA Rémi Mairesse Titouan Prevoteau

Guide utilisateur

DESCRIPTION

La commande TweetAnalyser.js parcourt une grande quantité de tweets, et renvoie une liste de tweets ou d'auteurs selon certains critères.
C'est donc la commande de base du logiciel que les chefs de projets utiliseront pour rédiger le rapport d'impact social media.
Cette commande de base peut aussi être utilisée pour exporter une liste de tweets et/ou pour générer un graphique et l'exporter.
Pour accomplir les différentes tâches mentionnées, la commande doit être complétée par d'autres commandes, arguments et options, il faudra se réferer au le manuel d'utilisation pour en savoir plus.
Mais toute utilisation du logiciel, merci de bien vouloir suivre les instructions d'installation ci-dessous.

INSTALLATION

Afin d'installer les dépendances, il est nécessaire d'exécuter la commande suivante dans le répertoire du logiciel :
npm install caporal colors fs vega-lite vega csv-parser path xml2js

De plus, avant d'exécuter le logiciel, il faut configurer le fichier de configuration.
Ce fichier s'intitule config.xml et se trouve à la racine du logiciel.x
Son architecture est la suivante :
<config>
<datadirectory value="C:\chemin_vers_le_répertoire_data">
</datadirectory></config>

Le répertoire data est le répertoire qui contient les répertoires qui contiennent les fichiers des tweets.

MANUEL D'UTILISATION

La commande à insérer dans l'invite de commande pour utiliser le logiciel est la suivante:

node TweetAnalyser.js [commande] [arguments] [options]

Les commandes utilisables et leurs options sont les suivantes:

Commande : top10Retweets
Retourne le top 10 des tweets les plus retweetés comportant un hashtag donné.

Arguments :
<hashtag>     Hashtag de référence     required

Options :
    -e, --export                 Exporte la liste dans le répertoire recherche (.txt)             optional
    -g, --graph                  Exporte un graphique dans le répertoire visualisation (.svg)     optional

Commande : top10auteur
Retourne les auteurs ayant le plus tweeté sur un hashtag donné.

Arguments :
    <hashtag>                    Hashtag de référence                                             required

Options :
    -e, --export                 Exporte la liste dans le répertoire recherche (.txt)             optional

Commande : rechercher
Affiche une liste de tweets correspondant à différents critères pouvant être combinés.
Arguments :

Options :
    -t, --tag     <hashtag>      Filtre par hashtag                                               optional
    -d, --date    <date>         Filtre par date (ex.: 12/28/2019)                                optional
    -k, --keyword <mot>          Filtre par mot clé                                               optional
    -a, --auteur  <auteur>       Filtre par auteur                                                optional
    -v, --verifie <true/false>   Filtre par certification                                         optional
    -l, --like    <nombre>       Filtre par nombre de like                                        optional
    -r, --retweet <nombre>       Filtre par nombre de retweet                                     optional
    -e, --export                 Exporte la liste dans le répertoire recherche (.txt)             optional

Commande : nbTweet
Recupère le nombre de tweet d'un hashtag donné sur une date/période.

Arguments :
    <hashtag>                    Hashtag de référence                                             required
    <dateDebut>                  Date de début au format 'MM/JJ/YYYY'                             required
    <dateFin>                    Date de fin au format 'MM/JJ/YYYY'                               optional

Options :
    -g, --graph                  Exporte un graphique dans le répertoire visualisation (.svg)     optional

Pour avoir plus d'informations sur une commande en particulier, on peut utiliser l'option "help" comme ceci:

node TweetAnalyser.js <commande> -h

Project Members: