====== rLE2P ======

===== Présentation =====

La libraire R //rLE2P// est un package contenant des fonctions utiles au sein du laboratoire (gestion de données, accès aux bases, applications, ...) sous le logiciel R. Le paquet est stocké sur [[tutos:github|GitHub]]: [[https://github.com/LE2P/rLE2P| rLE2P]]. 

L'accès au paquet est restreint en écriture aux contributeurs autorisés et en lecture pour tous les membres de l'organisation LE2P sur GitHub. Vous trouverez dans cette page comment installer le paquet et des exemples d'utilisation.

===== Installation =====

==== Pré requis ====

Il faudra bien sur installer sur sa machine : 
  * R : [[https://cloud.r-project.org/]]
  * RStudio : [[https://www.rstudio.com/products/rstudio/download/]]

Il est nécessaire de plus d'installer la libraire //devtools// :

<file rsplus installDevtools.R>
install.packages("devtools")
</file>

==== Méthode 1 : installation directe ====

Avec l'aide d'un token d’autorisation, on peut accéder au dépôt du projet sans avoir de compte GitHub ou s'y connecter. Le token est à demander auprès de Mathieu ([[mathieu.delsaut@univ-reunion.fr]]).

<note important>
N'importe qui connaissant ce token peut installer le code et obtenir le code source. Si vous penser l'avoir diffusé par erreur, prévenir l'administrateur qui peut aisément le changer. 
</note>

Pour installer le paquet, exécutez le code suivant :

<file rsplus installrLE2P.R>
library(devtools)
install_github(repo = 'LE2P/rLE2P', auth_token = 'letokenmagique')
</file>
==== Méthode 2 : compilation du paquet ====

Pour installer le paquet via sa compilation, il faut importer le code source du projet rLE2P sur votre machine.\\
Pour cela, à l'aide de git, exécutez la commande (votre identifiant et mot de passe GitHub seront demandés) : 
  * ssh :
<code>
git clone git@github.com:LE2P/rLE2P.git
</code>

  * https :
<code>
git clone https://github.com/LE2P/rLE2P.git
</code>

Vous pouvez aussi télécharger directement le répertoire du projet à l'adresse suivante : [[https://github.com/LE2P/rLE2P]].

{{ :tutos:clonerle2p.png?nolink |}}

----

Ensuite, dans le répertoire rLE2P, ouvrez le projet R //rLE2P.Rproj//:

{{ :tutos:rle2prep.png?nolink |}}

----

Enfin, dans l'interface de RStudio, dans l'onglet //Build// en haut à droite, cliquez sur //Install and Restart// :

{{ :tutos:installnrestart.png?nolink |}}


===== Configuration =====

Le paquet **rLE2P** nécessite une configuration afin de pouvoir fonctionner dans de bonnes conditions. Cette configuration sert à fournir à la librairie les adresses des serveurs et différents identifiants.
Ces paramètres sont stockés dans un fichier R spécifique à la définition de variables d'environnements : //.Renviron//; ce fichier se trouve à la racine de votre dossier personnel.

Voici les variables que l'ont doit renseigner dans ce fichier (certaines variables sont facultatives si on ne se sert pas de la fonction l'utilisant) :  

<file rsplus .Renviron>
rLE2P_mysql_host=le2p-mysql.univ.run
rLE2P_mysql_user=myuser
rLE2P_mysql_password=mypassword
rLE2P_mysql_dbname=mybddname
rLE2P_restHost=https://geosun.univ-reunion.fr
rLE2P_restUserPwd=myuser:mypassword
rLE2P_working_directory=/home/mathieu/Bureau/projetsRDivers/RepDataPgmRle2p
rLE2P_predHost=http://localhost:8000
</file>

Si ce fichier n'existe pas, le créer.\\
Vous obtiendrez vos identifiants auprès de l'administrateur des bases. 

===== Utilisation =====

==== Obtenir des données ====

=== La base MySQL ===

=== La base Cassandra ===

<file rsplus exampleCassandra.R>
library(rLE2P)
CassandraGetTransactionList()
myTr <- "1465989663"
CassandraGetSensorFromTransaction()
mySen <- "FG_Avg"
CassandraGetMetadata(myTr, mySen)
CassandraGetData(myTr, mySen, "2017-10-01 00:00:00", "2017-10-02 00:00:00")
</file>


==== Lancer les applications shiny ====

<file rsplus launchGraph.R>
install.packages("dygraphs")
CassandraGraph()
</file>

<file rsplus launchMap.R>
install.packages("leaflet")
CassandraMap()
</file>

===== Crédits =====

Développement : 
  * Pauline Mialhe : [[pauline.mialhe@univ-reunion.fr]],
  * Mathieu Delsaut : [[mathieu.delsaut@univ-reunion.fr]]