Menu ▾ ▴

Guide_User

Méthode (1) Débuter (1) Manuel (1) Utilisation (1)
Arbau

Ce guide est destiné aux utilisateurs de l'outil en ligne de commande "Messi". Il permettra une bonne prise en main grâce à une explication complète et concrète de ses différentes fonctionnalités.

Objectif global :

Cet outil en ligne de commande a pour but de faciliter la rédaction de rapports d'impact social pour les concernés. Ce dernier permet notamment de recenser et rendre plus lisible un ensemble d'informations provenant de fichiers de tweets sous le format ".csv".

Remarques :

  • Afin de fonctionner, l'outil en ligne de commande nécessite différents fichiers et un dossier : "caporalCli.js", "hashtag.js", "liste.js", "parser.js", "retweet.js", "tweet.js", "user.js" et le dossier "data". De plus, le logiciel recquiert des installations de certains modules (caporal, fs, colors, vega et vega-lite).

  • Afin de suivre ce tutoriel à la lettre, nous vous conseillons de vous rendre dans le "dossier receveur", celui dans lequel seront introduits tous les fichiers et dossier précédemment cités.

  • L'outil a été conçu de manière a créer de nombreux fichiers au fur-et-à-mesure de l'utilisation. Ainsi, afin que vous puissiez vous repérer, nous vous conseillons de prendre les dispositions nécessaires pour organiser votre dossier receveur de la manière la plus claire possible selon vos critères.

Fonctionnement général :

node caporalCli.js <Commande> [Arguments] [Options]

Commandes :

• createList : commande qui permet l'extraction d'informations de l'ensemble des tweets des fichiers ".csv" concernés et le regroupement dans un fichier ".txt", sous un format bien structuré (ID, URL, Auteur, Présentation, Date, Contenu, Nombre de retweets, Hashtag). En argument sera indiqué le nom du dossier qui sera scanné (ex. : createList data).
Remarque : Afin que toutes les fonctionnalités suivantes marchent correctement, il faut que le nom de dossier rentré soit "data" (car les fonctionnalités créées n'acceptent que le dossier "data" dans le parser, choix de l'équipe qui a programmé le logiciel). Un changement à ce niveau demanderait une révision totale du mode de fonctionnement de l'outil.

• mostRetweet <hashtag> [-t] : commande qui permet, pour un hashtag donné, de retourner le top des tweets ayant été le plus retweetés et de l'afficher dans un fichier. Par défaut, le top se fait sur une base de 10 tweets relevés. Cependant, grâce à l'option "-t" ou "--top" suivie d'un numéro, vous pouvez définir la longueur du top (ex. : mostRetweet EAW18 -t 20).

• famousAuthor : commande qui permet de retourner le top des auteurs ayant le plus de followers, puis de l'afficher dans un fichier. Tout comme la fonctionnalité précédente, par défaut, le top se fait sur une base de 10 auteurs relevés. A nouveau, il est possible de modifier la longueur de top affiché grâce à l'option "-t" ou "--top" suivie du numéro de longueur souhaitée (ex. : famousAuthor -t 30).

• hashtagAsso <hashtag> : commande qui permet de retourner l'ensemble des tweets ayant un hashtag contenant une partie ou l'entièreté du hashtag inséré en argument (ex. : hashtagAsso bonjour --> va chercher tous les tweets ayant pour hashtag AU MOINS la suite de caractère "bonjour"). A titre indicatif, un tweet contenant un autre tweet va aussi être retourné si ce dernier possède un hashtag validant la comparaison de chaînes de caractères.

• search [-iadt] <critère> : commande qui permet de lire/retourner l'ensemble des tweets qui correspondent à un critère de recherche défini par l'utilisateur (cf. [-iadt]). Il existe actuelleent 4 critères de recherche :

  1. "-i <ID>" ou "--id <ID>" --> faire une recherche selon un identifiant (ex. : search -i 976972553754464257).
  2. "-a <Auteur>" ou "--auteur <Auteur>" --> faire une recherche selon un auteur (ex. : search -a "Eileen Clancy").
  3. "-d <Date>" ou "--date <Date>" --> faire une recherche selon une date (ex. : search -d FriMar23).
  4. "-t <Hashtag>" ou "--hastag <Hashtag>" --> faire une recherche selon un hashtag (ex. : search -t EAW18).

• graphique <abscisse> <ordonnée> [-adt] : commande qui permet d'extraire les données de tweets qui correspondent, là aussi, à un critère de recherche défini par l'utilisateur (cf. [-adt]). De plus, cette commande permet de créer un graphique en ".svg", ayant pour abscisse et pour ordonnée les informations transmises par l'utilisateur (elles suivent une ensemble de combinaisons possibles que nous allons recenser plus bas), représentant les données extraites. Il existe, cette fois-ci, 3 critères de recherche :

  1. "-a <Auteur>" ou "--auteur <Auteur>" --> faire une recherhce seon l'auteur (ex. : graphique jour nbTweet "Eileen Clancy").
  2. "-d <Date>" ou "--date <Date>" --> faire une recherche selon une date (ex. : graphique jour nbTweet -d FriMar23).
  3. "-t <Hashtag>" ou "--hastag <Hashtag>" --> faire une recherche selon un hashtag (ex. : graphique jour nbTweet -t EAW18).
    Comme indiqué au dessus, l'utilisateur à l'opportunité de pouvoir choisir la combinaison d'informations qui serviront d'abscisses et d'ordonnées sur le graphique. La cohérence des données du tableau reste cependant à la charge de l'utilisateur.
    Les informations suivantes sont disponibles :
  4. Tweet --> tweet
  5. Nombre de likes --> nbLike
  6. Nombre de retweets --> nbRetweet
  7. Auteur --> auteur
  8. Nombre de followers --> follower
  9. Nombre d'amis --> ami
  10. Langue --> lang
  11. Localisation de publication --> place
  12. Date et heure de publication --> creation_at
  13. Nombre de listes de l'utilisateur --> user_listed_count
  14. Localisation de l'utilisateur --> user_location
    (ex. : graphique tweet nbLike | graphique auteur lang | graphique auteur user_location, etc.)

• hashtagPeriod <hashtag> <heureDébut> <heureFin> <jourDébut> <jourFin> [-a] : commande qui permet de retourner (dans le terminal, mais aussi dans un fichier ".txt") le nombre de tweets par rapport à un hashtag donné, sur une période de temps donnée elle aussi. Ainsi, cette commande traîte une période de temps suivant les heures, mais aussi suivant les jours. Pour votre information, l'outil de commande d'accepte que des heures sous forme de nombres entiers (ex. : 10h --> 10, 20h25 --> 20, ...).
De plus, l'utilisateur à la possibilité d'ajouter l'option "-a" qui permet d'afficher, dans le terminal, la moyenne du nombre de tweet par jour sur la période insérée dans la commande (ex. : hashtagPeriod EAW18 10 16 FriMar23 MonMar26 -a).

• tweetRegion : commande qui permet de retourner la proportion (en pourcentage) de tweet par zones géographiques. Cette fonctionnalité permet de créer un graphique en ".svg".

MongoDB Logo MongoDB