Repository files navigation

IDEATools est un package R dédié à la méthode IDEA4, visant à fourniraux utilisateurs des outils pour le traitement, l’automatisation et lereporting de diagnostics IDEA.

🎉 IDEATools est maintenant officiellement sur le cran 🎉

install.packages("IDEATools")

Vous pouvez toujours installer la dernière version en cours dedéveloppement :

install.packages("remotes")remotes::install_github("davidcarayon/IDEATools")

NB : Le logiciel RTools est parfois nécessaire sur les machines Windowspour l’installation de la version en cours de développement. Vous pouvezl’installer ici :Rtools

Une fois installé, vous pouvez charger le package avec :

library(IDEATools)

• Pour la production de rapport PDF, une installation de LaTeX estrequise. Si vous n’avez jamais utilisé LaTeX, vous pouvez utiliser lafonctiontinytex::install_tinytex() pour installer une versionminimale de LaTeX vous permettant d’éditer des rapports au format PDFen utilisant le package IDEATools. Une fois installé, vous n’avez plusbesoin de vous soucier de LaTeX (opération à réaliser seulement lorsde la première utilisation).

• Les rapports PDF utilisent (et nécessitent donc impérativement) lapoliceHelvetica. Il est donc important de l’avoir installée survotre machine.

Une interface graphique utilisateur (GUI) est proposée pour les plusnéophytes et permet l’utilisation d’IDEATools en presse-bouton. Ilsuffit simplement d’utiliser la fonction :

runGUI()

Une interface va alors s’ouvrir et proposer 3 différents modules :

• Analyses individuelles (1 seul calculateur)
• Analyses de groupe (>= 3 calculateurs, maintenir MAJ poursélectionner plusieurs calculateurs)
• Un module intituléjsonify2() qui permet de convertir un calculateurexcel IDEA en un fichier JSON, notamment utilisé par le WEBIDEA, dansle cas où la macro excel du calculateur ne fonctionnerait pas.

Pour des analyses plus poussées, pour automatiser par exemple plusieursdiagnostics individuels (i.e. du multi-individuel), les sectionsci-dessous détaillent l’utilisation plus classique du package.

Au total, 5 fonctions ou “modules” ont été développés dans ce package,allant de l’import des données d’un calculateur à la production degraphiques puis à la productions de produits de reporting (PDF, Excel,etc.) :

• read_idea() : Permet d’identifier la validité du fichier d’entrée etd’en extraire métadonnées et items.
• compute_idea() : Calcule lesindicateurs/composantes/dimensions/propriétés à partir des items
• old_idea() : Alternative aux deux fonctions précédentes si lecalculateur est trop ancien (vise les indicateurs plutôt que lesitems)
• plot_idea() : Produit les graphiques dimensions / propriétés
• write_idea() : Export des graphiques sous forme brute ou sous formede rapports aux formats variés.

Afin de simplifier l’utilisation du package, une fonction globalediag_idea() a été développée. Grâce à cette fonction, selon la saisiede l’utilisateur, les modules d’IDEATools vont être appelésséquentiellement afin de produire les résultats demandés. L’utilisateurpeut notamment paramétrer :

• Le fichier/dossier d’entrée des donnéesinput
• Le dossier de sortie des résultatsoutput_directory
• Le type d’analyse (individuelle ou de groupe)type
• Le type de sorties (rapport et/ou graphiques bruts)export_type
• Le types de graphiques qu’il souhaite (dans le cas d’un export brut)plot_choices
• Le format de sortie du rapport si désiré (au choix : pdf, docx, pptx,xlsx)report_format
• Le préfixe à rajouter aux fichiers de sortie (ex : le nom de la ferme)dans le cas d’une analyse individuelleprefix
• La résolution de sortie des graphiques (impacte notamment le poids dessorties)dpi
• Si l’algorithme doit afficher sa progression dans la console.quiet
• (nouveau) Dans le cas particulier ou un calculateur au format .xlsxest inséré et qu’un rapport individuel au format xlsx est demandé,append paramétré en TRUE permet de coller les onglets de résultats àla suite des onglets du calculateur initial, créant ainsi uncalculateur “tout en un” avec données + résultats.

Voici un appel complet à la fonctiondiag_idea() avec toutes lespossibilités de paramétrage :

diag_idea(input,output_directory,type= c("single","group"),export_type= c("report","local",NULL),plot_choices= c("dimensions","trees","radars"),report_format= c("pdf","docx","xlsx","pptx"),prefix="EA",dpi=300,quiet=FALSE,append=FALSE)

Pour information, les utilisateurs les moins habitués à l’écosystème Rpeuvent utiliser les commandes suivantes (à condition d’utiliserRStudio) pour sélectionner les dossier/fichiers via une fenêtre enpresse-bouton:

input<-rstudioapi::selectDirectory()# Dans le cas d'un répertoire# OUinput<-rstudioapi::selectFile()# Si un seul calculateuroutput_directory<-rstudioapi::selectDirectory()

On distingue 3 grands types de diagnostics :

En premier lieu, l’utilisateur peut avoir besoin d’un diagnostic pourune seule ferme. Prennons ici l’exemple d’utilisateur qui souhaiterécupérer ses résultats pour sa ferme, mais uniquement ses arbreséclairés. Le code sera alors :

diag_idea(input="chemin_calculateur",output_directory="mes_resultats",type="single",export_type="local",prefix="MaFerme",plot_choices="trees",quiet=FALSE)

Ensuite, certains utilisateurs ont besoin de traiter plusieurscalculateurs en même temps.

Ici par exemple, l’utilisateur n’a pas besoin des figures “brutes”, maisa juste besoin pour chaque exploitation d’un rapport au format wordqu’il pourra commenter ainsi qu’une présentation powerpoint contenanttoutes les figures et prête à projeter. Le code sera alors :

diag_idea(input="chemin_vers_dossier",output_directory="mes_resultats",type="single",export_type="report",report_format= c("docx","pptx"),quiet=FALSE)

Enfin, certains utilisateurs souhaitent traiter un ensemble decalculateurs en même temps et ont besoin d’avoir une vision globale surle groupe.

Dans cet exemple, l’utilisateur va donc demander à la fois desgraphiques bruts, mais aussi des rapports prêts à être imprimés (PDF)ainsi qu’un support excel qu’il pourra re-traiter à sa guise pour sonanalyse de group. Le code sera alors :

diag_idea(input="chemin_vers_dossier",output_directory="mes_resultats",type="group",export_type= c("report","local"),report_format= c("pdf","xlsx"),quiet=FALSE)

Notons qu’il peut demander, en plus de son analyse de groupe, desrapports individuels qu’il pourra donner à chaque exploitation (parexemple au format Microsoft Word) :

diag_idea(input="chemin_vers_dossier",output_directory="mes_resultats",type= c("group","single"),export_type= c("report"),report_format= c("docx"),quiet=FALSE)

Carayon D (2023).IDEATools: Individual and Group Farm SustainabilityAssessments using the IDEA4 Method. R package version 3.4.1,https://CRAN.R-project.org/package=IDEATools.

A BibTeX entry for LaTeX users is

  @Manual{,    title = {IDEATools: Individual and Group Farm Sustainability Assessments using theIDEA4 Method},    author = {David Carayon},    year = {2023},    note = {R package version 3.4.1},    url = {https://CRAN.R-project.org/package=IDEATools},  }