StatTag

le 13 avril 2018 à 12:44
communications

Quand vient le temps pour un statisticien de rédiger un rapport contenant les résultats de ses analyses statistiques, la tâche peut parfois être ardue, surtout lorsque le rapport doit être mis à jour fréquemment et qu’il contient plusieurs tableaux et figures. Le risque d’erreur et le temps perdu à faire leur copie peuvent miner le processus. La connaissance de certaines fonctionnalités d’exportation implémentées dans les logiciels statistiques peut simplifier cette tâche. Il existe cependant un nouvel outil, StatTag, qui permet de gérer tout cela directement à partir de Microsoft Word.

StatTag a été développé en 2016 par une équipe de Northwestern University Feinberg School of Medicine et est compatible avec Windows (version beta aussi disponible pour macOS). Le logiciel est un complément (plug-in) intégré dans Microsoft Word. On peut le télécharger sur le site web de StatTag après s’être créé un compte. Un guide de l’utilisateur ainsi que des tutoriaux sous forme de vidéos y sont aussi disponibles.

À partir de son ruban dans Word, StatTag permet d’intégrer des tags à du code R, SAS ou Stata. Ces tags permettent d’intégrer directement dans Word des tableaux, des figures et des valeurs produits par les logiciels statistiques, ainsi que de les mettre à jour automatiquement, suite à une modification des données ou du code.

asj_fig1

Figure 1 : Ruban de StatTag dans Microsoft Word

 

Démonstration avec R

 

L’exemple suivant vise à présenter des données descriptives du fichier de données Iris Plants Database de R.A. Fisher. La démonstration complète est effectuée avec du code R, alors qu’elle est également résumée pour SAS en fin de chronique. Les codes des deux programmes auraient même pu être utilisés dans le même document.

La première étape est de créer le programme dans le logiciel statistique de son choix et de s’assurer qu’il puisse être exécuté sans erreur.

asj_fig2

Figure 2 : Programme R
En cliquant sur l’onglet « Code Files », il est possible de sélectionner le ou les programmes (de R, SAS ou Stata) qui seront utilisés dans le document Word.

asj_fig3

Figure 3 : Sélection du programme dans « Code Files »

Ensuite, dans « Define Tag », on accède au contenu du programme que l’on a choisi. Pour chaque fonction, procédure ou résultat que l’on désire intégrer dans Word, on doit définir un tag différent. Pour se faire, il s’agit de cliquer dans la marge à gauche de la ou des lignes pertinentes dans le code pour qu’elles soient surlignées en mauve. Il est bien important de fonctionner de cette façon, et non pas simplement surligner le bout de code, car sinon le tag ne sera pas créé.

En haut à droite, on lui attribue un nom unique. Il faut spécifier le type de résultats : une valeur, une figure, un tableau ou du verbatim (tel que dans la sortie du logiciel source). Selon le type, différentes options supplémentaires sont disponibles.

Dans certains cas, il est nécessaire d’ajouter du code supplémentaire au programme original afin que le tag renvoie le résultat désiré. Par exemple, dans R, les figures fonctionnent seulement si le graphique est enregistré dans un format d’image tel que pdf, png ou jpg. Dans SAS, les résultats à intégrer sous forme de tableaux ainsi que de figures doivent être mis dans un fichier ODS CSV ou ODS PDF respectivement.

asj_fig4

Figure 4 : Création d’un tag pour les proportions sous forme de verbatim

asj_fig5

Figure 5: Création d’un tag pour une table des statistiques descriptives

asj_fig6

Figure 6: Création d’un tag pour une valeur avec le coefficient de corrélation

Si on ferme cette fenêtre après la création d’un tag, on peut voir en y retournant que le tag est incorporé sous forme de commentaire dans le code. Par exemple, avec du code R, la fonction de création du tag débute par un « # ». De plus, il est possible d’ajouter des lignes de code R ou d’y faire des modifications dans cette fenêtre sans avoir besoin de rouvrir R. Les changements apportés au code ici sont aussi effectués directement dans le code source. Il peut donc être plus sécuritaire de se créer une copie du code avant de l’utiliser dans StatTag. Cela implique aussi que l’on peut ouvrir un nouveau document Word et tous les tags déjà en commentaires dans le code source y seront importés directement.

asj_fig7a

asj_fig7b

Figure 7 : Création d’un tag pour une figure

Dans la figure 7, on remarque la particularité où le graphique doit être inséré dans un fichier PNG par exemple afin que StatTag puisse l’intégrer dans Word. La création d’un tag de figure avec la seule commande « hist » à la ligne 26 n’est pas fonctionnelle; la figure est ouverte dans le Graphics Device de R lors de l’exécution du tag dans ce cas, plutôt que d’être insérée dans Word.

Après avoir enregistré chacun des tags désirés, il est possible d’aller insérer leur contenu dans le document Word à l’endroit désiré. Lorsque le curseur est au bon endroit dans le document, cliquer sur « Insert Tag Output » et sélectionner le tag à insérer.

asj_fig8

Figure 8 : Sélectionner le tag à insérer avec « Insert Tag Output » 

Quelques secondes s’écouleront ensuite pendant que StatTag exécute le code R et génère le résultat demandé. Plus le code est long, même si seulement un tag est défini, plus l’attente sera longue. Il vaut donc mieux couper le code qui ne sera pas pertinent dans le rapport.

asj_fig9

Figure 9 : Résultats des deux premiers tags

On peut voir que le tableau n’est pas superbe, avec le nombre de décimales variable, et le nom des statistiques n’ayant pas apparu. Le verbatim aurait été une alternative préférable ici. Par contre, pour la valeur et le graphique, l’affichage est adéquat comme on peut le voir dans la figure suivante.

asj_fig10

Figure 10 : Résultats des deux derniers tags

Options supplémentaires

Divers autres onglets sont disponibles. « Update Tag Output » permet de mettre à jour les résultats des tags dans Word en exécutant le code à nouveau, si, par exemple, le fichier de données a été modifié. « Manage tags » permet d’avoir une vue d’ensemble des tags créés et de les modifier. « Troubleshoot Tags » permet de vérifier si des tags existent en double. Dans les « Settings », on peut créer un fichier de débogage contenant le journal d’exécution de StatTag. En cas de problème d’utilisation, il est recommandé d’envoyer à l’équipe de StatTag ce fichier qui leur permettra de mieux comprendre le problème.

asj_fig11

Figure 11 : Gestion des tags

asj_fig12

Figure 12 : Création d’un fichier de débogage

 

 

Exemple avec SAS

Les mêmes données ont été utilisées pour produire un exemple dans SAS. Les tags déjà définis apparaissent dans le code dans des commentaires débutant par des « * ». On note que la figure provenant de PROC GPLOT est insérée dans un fichier PDF, alors que le tableau de PROC FREQ est dans un fichier CSV. Pour le verbatim, il faut s’assurer que la mise en page du document est adéquate afin que le résultat soit affiché correctement et que tout soit aligné. Par exemple, dans mon document original avec orientation portrait, les résultats de la procédure MEANS étaient décalés et compliqués à interpréter.

asj_fig13

Figure 13 : Code SAS avec tags déjà intégrés

asj_fig14

Figure 14 : Résultats des tags de SAS

Avantages :

  • Écrire directement dans Word le programme statistique tout en y insérant les tags.
  • Pas besoin de copier-coller entre les logiciels statistiques et Word.
  • Avoir directement dans un même document les résultats et le texte du rapport.
  • Réutiliser dans plusieurs documents des tags incorporés dans les commentaires des programmes statistiques.
  • L’équipe de StatTag est efficace et rapide pour résoudre les problèmes des utilisateurs (du moins les miens, un 2 janvier!)

Désavantages :

  • La version du logiciel statistique peut être problématique. Pour l’exemple, j’ai utilisé la même version que celle utilisée lors du développement (3.1.3), alors que c’était non fonctionnel avec la dernière version de R (3.4.3).
  • Du temps supplémentaire est requis pour créer les tags dans Word, ou bien les coder directement dans le logiciel statistique.
  • Les tags sont insérés directement dans le code source de R, SAS ou Stata.
  • Du code supplémentaire doit être écrit pour insérer correctement les tableaux et les figures.
  • Plusieurs combinaisons de code et de types de tags sont non compatibles et génèrent des «  no results ».
  • Le temps d’exécution pourrait être plus rapide.
  • L’affichage acceptable de verbatim et de tableaux nécessite parfois de la mise en page supplémentaire.

 

En résumé, StatTag est un outil prometteur, mais qui n’est pas encore parfait. Lors de mon test, j’ai dû faire plusieurs essais et erreurs pour comprendre de quelle façon générer chacun des résultats de façon optimale. Heureusement, l’outil est simple et facile à utiliser. Il a du potentiel pour nous simplifier la vie dans des rapports où plusieurs résultats sont à intégrer et de façon récurrente. Avec chance, les prochaines mises à jour de StatTag permettront d’améliorer les lacunes de ce complément Word pour le rendre encore plus agréable à utiliser.

 

Par Anne-Sophie Charest

Pour retourner à la page principale.

FacebookTwitterGoogle+LinkedIn