Premier readme

README.md

@@ -1 +1,67 @@
 # Scripts d'automatisation de cloture mensuelle
+
+## Installation
+
+Les scripts ont été développés sous R version 3.2.3, à l'aide des packages suivants :
+
+* Versions stables (CRAN)
+  * tidyr 0.4.1
+  * ggplot2 2.1.0
+  * lubridate 1.5.6
+  * rvest 0.3.1
+  * stringr 1.0.0
+  * readr 0.2.2
+  * magrittr 1.5
+  * dplyr 0.4.3.9001
+
+* Versions de développement (github)
+  * DT 0.1.45
+  * knitr 1.13
+  * rmarkdown 0.9.6
+  * htmlwidgets 0.6.1
+
+Ces paquets sont installés au niveau système pour tous les utilisateurs livenne.
+
+## Utilisation
+
+La génération du rapport est séparée en deux parties :
+* l'acquisition et le pré-traitement des données
+* la génération du rapport en lui-même
+
+Il convient pour le moment d'**archiver** le rapport précédent dans le sous-répertoire *archives*, avant de générer un nouveau rapport !
+
+### Acquisition des données
+
+Une première étape manuelle consiste à utiliser la requête Business Objects **Exhaustivite.wid** présente dans le répertoire et de sauvegarder le fichier csv (format par défaut : séparateur = ",") sous le nom **exhau_pims.csv** dans le répertoire du script.
+
+Le script **donnees.sh** appelle le script **donnees.R** qui récupère les autres données depuis les différentes sources (base de données MySQL sur livenne et données ePMSI sur le site de l'ATIH). Il nécessite un appel en ligne de commande avec les paramètres suivants :
+* nom d'utilisateur de session CHU
+* mot de passe de session CHU (pour passer à travers le proxy)
+
+* nom d'utilisateur ePMSI
+* mot de passe ePMSI
+
+* nom d'utilisateur MySQL livenne
+* mot de passe MySQL livenne
+
+* annee de la clôture
+* mois de la clôture
+
+Un appel incorrect au script rappelle les paramètres de ligne de commande à utiliser.
+Les noms d'utilisateurs/mots de passe contenant des caractères spéciaux (autres qu'alphanumériques) doivent être entourés de guillemets.
+
+Le script **donnees.R** utilise le fichier **Ovalide.Rdata** contenant les données fusionnées du CHU et du CCEG pour 2015. Après 2016 ce fichier ne sera plus utile. Il utilise également le fichier **exhau.Rdata** pour sauvegarder les données d'exhaustivité depuis le début de l'année en cours. Ce fichier est réinitialisé en début d'années.
+
+Les données récupérées et pré-traitées son enregistrées dans le fichier **donnees.Rdata** pour l'utilisation par le script de génération du rapport.
+
+### Génération du rapport
+
+Le script **render.sh** appelle la commande *render* de Rmarkdown pour générer le rapport de clôture **cloture.html** à partir du fichier **cloture.Rmd**.
+Celui-ci génère les différents tableaux et figures à la volée à partir des données pré-traitées fournies par **donnees.R** dans le fichier **donnees.Rdata**.
+
+Le fichier **cloture.html** généré est automatiquement utilisé par Joomla pour servir la page web.
+
+À l'heure de l'écriture de ce script, certains packages sont utilisés dans leur version de dévelopemment pour profiter de certaines fonctionnalités :
+
+* DT : format numérique complexe à l'aide de *formatCurrency*
+* knitr, rmarkdown, htmlwidgets : mise en forme avec *tabs* et *collapsibles* bootstrap automatique, et gestion des *widgets* cachés à l'affichage de la page.