Guide de démarage utilisateur

Guide de démarrage utilisateur

Nom d'équipe: Team4Software
Auteurs: Manon Caroy, Augustin Borne, Jacques Mironneau
Licences:MIT

I - Aide et Installation

Récupérez le projet, lancez depuis un terminal la commande :
npm install
(installe toutes les dépendances nécessaires)

Pour vérifier que le projet est correctement installé, une page d’aide sur le logiciel devrait apparaître avec la commande :
node tea.js help
Les commandes existantes sont affichées dans le node tea.js help :
node tea.js help <nom-commande>

Une date est représentée sous la forme dd/mm/yyyy soit 02/03/2020 pour le 2 mars 2020.
Chaque commande possède un alias: listeHashtag est équivalent à lh.

II - Fonctionnalités

Filtrer et afficher les tweets sous forme de texte selon différents critères de recherche

node tea.js criteres <files> [auteur][hashtag][nbRetweet][SelectionDate]
Alias :
node tea.js c <files> [auteur][hashtag][NbRetweet][SelectionDate]
Argument :
<files> : Liste des fichiers de données (tweets)
Options :
[auteur] : Auteur d'un tweet(--auteur <auteur> | -a <auteur>)
[hashtag] : Hashtag d'un tweet(--hashtag <hashtag>)
[NbRetweet] : Nombre de retweets d'un tweet
- --nbrt <nbde retweet> --equal | --nbrt <nb de retweet> --superieur | --nbrt <nb de retweet> --inferieur
- -r <nbde retweet> -e | -r <nb de retweet> -s | -r <nb de retweet> -i
[SelectionDate] : intervalle de date ou date unique au format dd/mm/yyyy
- --dateequal <date> | --datesup <date> | --dateinf <date> | --dateinf <date> --datesup <date>
- --dateequal <date> | --datesup <date> | --dateinf <date> | --dateinf <date> --datesup <date>

Exemple :
node tea.js criteres tweets.csv --hashtag eaw18 --dateinf 27/03/2018 --datesup 29/03/2018
node tea.js criteres tweets.csv --author ”anna bialas”
node tea.js c tweets.csv --author ”anna bialas" --nbRt 10 --superieur

Récupérer le nombre de tweets sur un hashtag pour une période donnée par journée

node tea.js nbtweet <files> <hashtag> <periodBegin> <periodEnd> [format]
Alias :
node tea.js nbt <files> <hashtag>
Arguments :
<files> : liste des fichiers de données (tweets)
<Hashtag> : Hashtag d'un tweet
<periodBegin> : date au format dd/mm/yyyy
<periodEnd> : date au format dd/mm/yyyy
Option :
[format] : format du graphique de sortie: png ou svg (par défaut svg)(--png | -p)
Exemple :
node tea.js nbtweet tweets.csv eaw18 02/02/2018 03/03/2018
node tea.js nbt tweets.csv eaw18 02/02/2018 03/03/2018

Top 10 des tweets ayant été les plus retweetés pour un hashtag donné

node tea.js top10rt <files> <hashtag> [format]
Alias :
node tea.js trt <files> <hashtag> [format]
node tea.js trt <files> <hashtag> [format]
Arguments :
<files> : liste des fichiers de données (tweets)
<Hashtag> : Hashtag d'un tweet
Option :
[format] : format du graphique de sortie: png ou svg (par défaut svg)(--png | -p)
Exemple :
node tea.js top10rt tweets.csv eaw18 --png
node tea.js trt tweets.csv eaw18

Top 10 des auteurs de tweets avec le plus d'informations à leur sujet

node tea.js top10auteur <files> [format]
Alias :
node tea.js top10auteur <files> [format]
node tea.js taut <files> [format]
Arguments :
<files> : liste des fichiers de données (tweets)
Option :
[format] : format du graphique de sortie: png ou svg (par défaut svg)(--png | -p)
Exemple :
node tea.js top10auteur tweet.csv
node tea.js taut tweet.csv

Liste des hashtags associés à un hashtag de référence

node tea.js listeHashtag <files> <hashtag> [format]
Alias :
node tea.js lh <files> <hashtag> [format]
Arguments :
<files> : liste des fichiers de données (tweets)
<Hashtag> :Hashtag d'un tweet
Option :
[format] : format du graphique de sortie: png ou svg (par défaut svg)(--png | -p)
Exemple :
node tea.js listeHashtags tweets.csv utt
node tea.js lh tweets.csv utt

Visualiser la proportion de tweets par pays/région

node tea.js proportion <files> [albersUsa] [roundedMap] [format]
Alias :
node tea.js proportion <files> [albersUsa] [roundedMap] [format]
node tea.js p <files> [albersUsa] [roundedMap] [format]
Arguments :
<files> : liste des fichiers de données (tweets)
Options :
[format] : format du graphique de sortie: png ou svg (par défaut svg)(--png | -p)
[alberUsa] : utilisation de la projection albersUsa (Carte des États-Unis)(-u | --albersUsa )
[roundedMap] : utilisation de la projection roundedmap (Carte du monde)(-r | --roundedMap)

Exemple :
node tea.js proportion tweets.csv --roundedMap
node tea.js p tweets.csv -u --png
node tea.js p tweets.csv -r
node tea.js p tweets.csv