README.md

In Sebastien-Le/YesSiR: What the Package Does (One Line, Title Case)

YesSiR

The YesSiR package is a follow-up to the EnQuireR package. You can find some information about the EnQuireR package by clicking on this link or on this one; if you want to download it, go to the CRAN (Packages, then Archive). The main objective of the EnQuireR package was the creation of automatic reports for survey data. The automatic generation of reports was carried out using Sweave and Latex (link1, link2, link3, link4): as you can see, thanks to the work of Friedrich Leisch, it’s been two decades that statistical reports can be generated with R.

Since then, technology has evolved and it’s hard to imagine a presentation without PowerPoint. The aim of the YesSiR package is to generate automatic reports in PowerPoint format. It works thanks to the work of David Gohel and his famous package officer. The functions in the YesSiR package take as input the results of the PCA(), MCA() and textual() functions in the FactoMineR package, as well as the results of the decat() function in the SensoMineR package. These functions produce a report in the form of a PowerPoint presentation which is automatically saved in the working directory (by default).

This package would not have been possible without the hard work and efficiency of Maxime Saland. The main purpose of the package is to demonstrate what can be achieved in terms of automatic reporting. Adjustments will need to be made to suit specific practices and applications.

Installation

You can install the released version of YesSiR from GitHub with:

# First install and load the devtools package
install.packages("devtools")
library(devtools)

# Then install and load the YesSiR package
devtools::install_github("Sebastien-Le/YesSiR")
library(YesSiR)

Output

Let’s have a look at how it works with a PCA:

# First install and load the FactoMineR package
install.packages("FactoMineR")
library(FactoMineR)

# Then generate the results you want to put in your PowerPoint
data(decathlon)
res.pca <- FactoMineR::PCA(decathlon, quanti.sup = 11:12, quali.sup=13)

# Finally create the PowerPoint in the working directory with the Yes_PCA() function
Yes_PCA(res.pca)

If you want to have a look at the PowerPoint presentation that has been created, you can download it here (small icon on your right).

Now, let’s have a look at how it works with sensory data and in particular with QDA data:

# First install and load the SensoMineR package
install.packages("SensoMineR")
library(SensoMineR)

# Then generate the results you want to put in your PowerPoint
data("sensochoc")
res.decat <- SensoMineR::decat(sensochoc, formul="~Product+Panelist", firstvar = 5, graph = FALSE)

# Finally create the PowerPoint in the working directory with the Yes_decat() function
Yes_decat(res.decat)

If you want to have a look at the PowerPoint presentation that has been created, you can download it here (small icon on your right).

Sebastien-Le/YesSiR documentation built on Sept. 3, 2023, 8:53 a.m.