Guide de démarrage utilisateur

Prérequis: **
NodeJS >= 15.0 et les paquets npm vega et vega-lite

**Installation: **
Executer la commande dans un terminal dans le dossier du logiciel :

npm install

!ATTENTION !
Au lancement du logiciel il est important d'appeler la commande import.
Les données seront ensuite chargées dans le programme et on pourra effectuer plusieurs traitements sur ce jeu de données.
Il sera possible d'extraire des graphiques, des listes de tweets, d'auteurs et de hashtags à tout moment.
La seule contrainte présente sur ces extractions est que la liste d'objets en cours de traitement doit être compatible avec l'export associé.
Exemple : il n'est pas possible de demander un graphique concernant le nombre de retweets par rapport à un utilisateur lorsqu'on a précédemment demandé de récupérer une liste de hashtags.
Le type de données présent dans le logiciel est indiqué par dataType au dessus de la commande à saisir.

**Utilisation du logiciel: **

• Lancement du pseudo-terminal : node Index.js
• importation des données avec la commande : import <dossier tweets> (de base ./donneesSujetA)
• la commande help affiche toutes les commandes disponibles dans le logiciel
• man <nom commande> permet d'afficher le manuel lié à la commande
• use <nom commande> permet d'afficher les arguments à donner à la commande
• la commande help affiche la liste des fonctions présentes dans le programme
• la commande print affiche les données en cours de traitement
• la commande exit permet de sortir du programme

**Les types de données: **
Le type de données présent dans le logiciel est indiqué par dataType au dessus de la commande à saisir.

• Aucun jeu de données importé : null
• Une liste de tweets : TweetList
• Une liste d'auteurs de tweets, avec un nombre de retweets cumulés associé : AuthorList
• Une liste de mots. Seul un affichage ou un export est disponible à partir de ce type de données :HashtagList
• Un nombre : number

**Les Fonctions disponibles : **

• import: importer des données
• exit: quitter le logiciel
• print: afficher à l'écran les datas actuelles
• relhastags: obtenir les hashtags liés à un hashtag avec un niveau de proximité
• listgraph: exporter un graphique sur une liste de tweets ou d'auteurs
• exportTweet: exporter une liste de tweets au format ABNF
• tweetcount: récupérer le nombre de tweets avec un hashtag dans un intervalle de temps
• top10mrfh: récupérer les 10 tweets les plus retweetés par rapport à un hashtag. Saisir * en hashtags pour traiter tous les hashtags
• top10mrafh: récupérer les 10 auteurs les plus retweetés par rapport à un hashtag
• exporthashlist: exporter une liste de hashtags au format JSON
• exportauthlist: exporter une liste d'auteurs au format JSON
• tweetMap: exporter une map qui compte les tweets par pays
• tweetbarChart: exporter un graphique en barres qui présente les emplacements les plus fréquents des tweets
• search: rechercher des tweets selon des critères précis

**Exemples d'utilisation d'une fonction (search): **
Rechercher les tweets qui ne contiennent que EAW18
search "[{""criteriaName"":""hashtags"", ""value"":""EAW18"", ""operand"":""=""}]"
Rechercher les tweets qui contiennent plus de 50 retweets
search "[{""criteriaName"":""retweet_count"", ""value"":""50"", ""operand"":"">""}]"