Type:	Package
Title:	Interface Between the 'JDemetra+' Cruncher and R, and Quality Report Generator
Version:	0.3.5
Description:	Tool for generating quality reports from cruncher outputs (and calculating series scores). The latest version of the cruncher can be downloaded here: https://github.com/jdemetra/jwsacruncher/releases.
License:	EUPL version 1.1 | EUPL version 1.2 [expanded from: EUPL]
URL:	https://github.com/InseeFr/JDCruncheR, https://inseefr.github.io/JDCruncheR/
BugReports:	https://github.com/InseeFr/JDCruncheR/issues
Depends:	R (≥ 4.1)
Imports:	openxlsx, stats, tools, utils
Suggests:	testthat (≥ 3.0.0)
Config/testthat/edition:	3
Encoding:	UTF-8
RoxygenNote:	7.3.2
NeedsCompilation:	no
Packaged:	2025-04-15 08:43:56 UTC; UTZK0M
Author:	Tanguy Barthelemy [aut, cre, art], Alain Quartier-la-Tente [aut], Institut national de la statistique et des études économiques [cph] (https://www.insee.fr/), Anna Smyk [aut]
Maintainer:	Tanguy Barthelemy <tanguy.barthelemy@insee.fr>
Repository:	CRAN
Date/Publication:	2025-04-15 09:10:02 UTC

JDCruncheR: Interface Between the 'JDemetra+' Cruncher and R, and Quality Report Generator

Description

Tool for generating quality reports from cruncher outputs (and calculating series scores). The latest version of the cruncher can be downloaded here: https://github.com/jdemetra/jwsacruncher/releases.

Author(s)

Maintainer: Tanguy Barthelemy tanguy.barthelemy@insee.fr [artist]

Authors:

• Alain Quartier-la-Tente alain.quartier-la-tente@insee.fr (ORCID)

• Anna Smyk anna.smyk@insee.fr

Other contributors:

• Institut national de la statistique et des études économiques (https://www.insee.fr/) [copyright holder]

See Also

Useful links:

• https://github.com/InseeFr/JDCruncheR

• https://inseefr.github.io/JDCruncheR/

• Report bugs at https://github.com/InseeFr/JDCruncheR/issues

Quality report objects

Description

mQR_matrix() and QR_matrix() are creating one (or several) quality report. The function is.QR_matrix() and is.mQR_matrix() are functions to test whether an object is a quality report or a list of quality reports.

Usage

QR_matrix(modalities = NULL, values = NULL, score_formula = NULL)

mQR_matrix(x = list(), ...)

is.QR_matrix(x)

is.mQR_matrix(x)

Arguments

Details

AQR_matrix object is a list of three items:

• modalities, a data.frame containing a set of categorical variables (by default: Good, Uncertain, Bad, Severe).

• values, a data.frame containing the values corresponding to the modalities indicators (i.e. p-values, statistics, etc.), as well as variables for which a modality cannot be defined (e.g. the series frequency, the ARIMA model, etc).

• score_formula contains the formula used to calculate the series score (once the calculus is done).

Value

QR_matrix() creates and returns a QR_matrix object. mQR_matrix() creates and returns a mQR_matrix object (ie. a list of QR_matrix objects). is.QR_matrix() and is.mQR_matrix() return Boolean values (TRUE or FALSE).

See Also

Traduction française

Editing the indicators list

Description

Functions to remove indicators (remove_indicators()) or retrain some indicators only (retain_indicators()) from QR_matrix or mQR_matrix objects. The series names (column "series") cannot be removed.

Usage

remove_indicators(x, ...)

retain_indicators(x, ...)

Arguments

Value

remove_indicators() returns the same object x reduced by the flags and variables used as arguments ... So if the input x is a QR_matrix, an object of class QR_matrix is returned. If the input x is a mQR_matrix, an object of class mQR_matrix is returned.

See Also

Traduction française

Other var QR_matrix manipulation: add_indicator(), recode_indicator_num()

Examples

# Path of matrix demetra_m
demetra_path <- file.path(
    system.file("extdata", package = "JDCruncheR"),
    "WS/ws_ipi/Output/SAProcessing-1",
    "demetra_m.csv"
)

# Extract the quality report from the demetra_m file
QR <- extract_QR(demetra_path)

# Compute the score
QR <- compute_score(QR, n_contrib_score = 2)

# Retain indicators
retain_indicators(QR, "score", "m7") # retaining "score" and "m7"
retain_indicators(QR, c("score", "m7")) # Same

# Remove indicators
QR <- remove_indicators(QR, "score") # removing "score"

extract_score(QR) # is NULL because we removed the score indicator

Adding an indicator in QR_matrix objects

Description

Function to add indicators in QR_matrix objects.

Usage

add_indicator(x, indicator, variable_name, ...)

Arguments

Details

The function add_indicator() adds the chosen indicator to the values matrix of a quality report. Therefore, because said indicator isn't added in the modalities matrix, it cannot be used to calculate a score (except for weighting). Before using the added variable for score calculation, it will have to be coded with the function recode_indicator_num.

The new indicator can be a vector or a data.frame. In both cases, its format must allow for pairing:

• a vector's elements must be named and these names must match those of the quality report (variable "series");

• a data.frame must contain a "series" column that matches with the quality report's series.

Value

This function returns the same object, enhanced with the chosen indicator. So if the input x is a QR_matrix, an object of class QR_matrix is returned. If the input x is a mQR_matrix, an object of class mQR_matrix is returned.

See Also

Traduction française

Other var QR_matrix manipulation: QR_var_manipulation, recode_indicator_num()

Score calculation

Description

To calculate a score for each series from a quality report

Usage

## S3 method for class 'QR_matrix'
compute_score(
  x,
  score_pond = c(qs_residual_sa_on_sa = 30L, f_residual_sa_on_sa = 30L,
    qs_residual_sa_on_i = 20L, f_residual_sa_on_i = 20L, f_residual_td_on_sa = 30L,
    f_residual_td_on_i = 20L, oos_mean = 15L, oos_mse = 10L, residuals_independency =
    15L, residuals_homoskedasticity = 5L, residuals_skewness = 5L, m7 = 5L, q_m2 = 5L),
  modalities = c("Good", "Uncertain", "", "Bad", "Severe"),
  normalize_score_value,
  na.rm = TRUE,
  n_contrib_score,
  conditional_indicator = NULL,
  thresholds = getOption("jdc_thresholds"),
  ...
)

## S3 method for class 'mQR_matrix'
compute_score(x, ...)

Arguments

Details

The function compute_score calculates a score from the modalities of a quality report: to each modality corresponds a weight that depends on the parameter modalities. The default parameter is c("Good", "Uncertain", "Bad","Severe"), and the associated weights are respectively 0, 1, 2 and 3.

The score calculation is based on the score_pond parameter, which is a named integer vector containing the weights to apply to the (modalities matrix) variables. For example, with score_pond = c(qs_residual_sa_on_sa = 10, f_residual_td_on_sa = 5), the score will be based on the variables qs_residual_sa_on_sa and f_residual_td_on_sa. The qs_residual_sa_on_sa grades will be multiplied by 10 and the f_residual_td_on_sa grades, by 5. To ignore the missing values when calculating a score, use the parameter na.rm = TRUE.

The parameter normalize_score_value can be used to normalise the scores. For example, to have all scores between 0 and 20, specify normalize_score_value = 20.

When using parameter n_contrib_score, n_contrib_score new variables are added to the quality report's values matrix. These new variables store the names of the variables that contribute the most to the series score. For example, n_contrib_score = 3 will add to the values matrix the three variables that contribute the most to the score. The new variables' names are i_highest_score, with i being the rank in terms of contribution to the score (1_highest_score contains the name of the greatest contributor, 2_highest_score the second greatest, etc). Only the variables that have a non-zero contribution to the score are taken into account: if a series score is 0, all i_highest_score variables will be empty. And if a series score is positive only because of the m7 statistic, 1_highest_score will have a value of "m7" for this series and the other i_highest_score will be empty.

Some indicators are only relevant under certain conditions. For example, the homoscedasticity test is only valid when the residuals are independant, and the normality tests, only when the residuals are both independant and homoscedastic. In these cases, the parameter conditional_indicator can be of use since it reduces the weight of some variables down to 1 when some conditions are met. conditional_indicator is a list of 3-elements sub-lists:

• "indicator": the variable whose weight will be conditionally changed

• "conditions": the variables used to define the conditions

• "conditions_modalities": modalities that must be verified to induce the weight change For example, conditional_indicator = list(list(indicator = "residuals_skewness", conditions = c("residuals_independency", "residuals_homoskedasticity"), conditions_modalities = c("Bad","Severe"))), reduces down to 1 the weight of the variable "residuals_skewness" when the modalities of the independancy test ("residuals_independency") or the homoscedasticity test ("residuals_homoskedasticity") are "Bad" or "Severe".

Value

a QR_matrix or mQR_matrix object.

See Also

Traduction française

Examples

# Path of matrix demetra_m
demetra_path <- file.path(
    system.file("extdata", package = "JDCruncheR"),
    "WS/ws_ipi/Output/SAProcessing-1",
    "demetra_m.csv"
)

# Extract the quality report from the demetra_m file
QR <- extract_QR(demetra_path)

# Calculer le score
QR <- compute_score(QR, n_contrib_score = 2)
print(QR)

# Extract the modalities matrix:
QR[["modalities"]][["score"]]

Exporting QR_matrix or mQR_matrix objects in an Excel file

Description

Exporting QR_matrix or mQR_matrix objects in an Excel file

Usage

export_xlsx(x, ...)

Arguments

Value

If x is a mQR_matrix, the function returns invisibly (via invisible(x)) the same mQR_matrix object as x. Else if x is a QR_matrix, the function returns invisibly (via invisible(x)) a workbook object created by XLConnect::loadWorkbook() for further manipulation.

See Also

Other QR_matrix functions: export_xlsx.QR_matrix(), export_xlsx.mQR_matrix(), extract_QR(), rbind.QR_matrix(), sort(), weighted_score()

Exporting QR_matrix objects in an Excel file

Description

To export a quality report in an Excel file.

Usage

## S3 method for class 'QR_matrix'
export_xlsx(x, file, auto_format = TRUE, overwrite = TRUE, ...)

Arguments

Value

Returns invisibly (via invisible(x)) a workbook object created by XLConnect::loadWorkbook() for further manipulation.

See Also

Traduction française

Other QR_matrix functions: export_xlsx(), export_xlsx.mQR_matrix(), extract_QR(), rbind.QR_matrix(), sort(), weighted_score()

Exporting mQR_matrix objects in Excel files

Description

To export several quality reports in Excel files

Usage

## S3 method for class 'mQR_matrix'
export_xlsx(
  x,
  export_dir,
  layout_file = c("ByComponent", "ByQRMatrix", "AllTogether"),
  auto_format = TRUE,
  overwrite = TRUE,
  ...
)

Arguments

Value

Returns invisibly (via invisible(x)) the same mQR_matrix object as x.

See Also

Traduction française

Other QR_matrix functions: export_xlsx(), export_xlsx.QR_matrix(), extract_QR(), rbind.QR_matrix(), sort(), weighted_score()

Extraction of a quality report

Description

To extract a quality report from the csv file containing the diagnostics matrix.

Usage

extract_QR(
  file,
  x,
  matrix_output_file,
  sep = ";",
  dec = ",",
  thresholds = getOption("jdc_thresholds")
)

Arguments

Details

This function generates a quality report from a csv file containing diagnostics (usually from the file demetra_m.csv). The demetra_m.csv file can be generated by launching the cruncher (functions cruncher or cruncher_and_param) with the default export parameters, having used the default option csv_layout = "vtable" to format the output tables of the functions cruncher_and_param and create_param_file when creating the parameters file.

This function returns a QR_matrix object, which is a list of 3 objects:

• modalities, a data.frame containing several indicators and their categorical quality (Good, Uncertain, Bad, Severe).

• values, a data.frame containing the same indicators and the values that lead to their quality category (i.e.: p-values, statistics, etc.) as well as additional variables that don't have a modality/quality (series frequency and arima model).

• score_formula that will store the formula used to calculate the score (when relevant). Its initial value is NULL.

If x is supplied, the file and matrix_output_file arguments are ignored. The file argument also designates the path to the file containing the diagnostic matrix (which can be imported into R in parallel and used with the x argument).

Value

a QR_matrix object.

See Also

Traduction française

Other QR_matrix functions: export_xlsx(), export_xlsx.QR_matrix(), export_xlsx.mQR_matrix(), rbind.QR_matrix(), sort(), weighted_score()

Examples

# Path of matrix demetra_m
demetra_path <- file.path(
    system.file("extdata", package = "JDCruncheR"),
    "WS/ws_ipi/Output/SAProcessing-1",
    "demetra_m.csv"
)

# Extract the quality report from the demetra_m file
QR <- extract_QR(file = demetra_path)

print(QR)

# Extract the modalities matrix:
QR[["modalities"]]
# Or:
QR[["modalities"]]

Score extraction

Description

To extract score variables from QR_matrix or mQR_matrix objects.

Usage

extract_score(
  x,
  format_output = c("data.frame", "vector"),
  weighted_score = FALSE
)

Arguments

Details

For QR_matrix objects, the output is a vector or the object NULL if no score was previously calculated. For mQR_matrix objects, it is a list of scores (NULL elements or vectors).

Value

extract_score() returns a data.frame with two column: the series name and their score.

See Also

Traduction française

Examples

# Path of matrix demetra_m
demetra_path <- file.path(
    system.file("extdata", package = "JDCruncheR"),
    "WS/ws_ipi/Output/SAProcessing-1",
    "demetra_m.csv"
)

# Extract the quality report from the demetra_m file
QR <- extract_QR(demetra_path)

# Compute the score
QR1 <- compute_score(x = QR, n_contrib_score = 5)
QR2 <- compute_score(
    x = QR,
    score_pond = c(qs_residual_sa_on_sa = 5, qs_residual_sa_on_i = 30,
                   f_residual_td_on_sa = 10, f_residual_td_on_i = 40,
                   oos_mean = 30, residuals_skewness = 15, m7 = 25)
)
mQR <- mQR_matrix(list(a = QR1, b = QR2))

# Extract score
extract_score(QR1)
extract_score(mQR)

Objets bilan qualité

Description

QR_matrix() permet de créer un objet de type QR_matrix contenant un bilan qualité.

Arguments

Details

mQR_matrix() permet de créer un objet de type mQR_matrix qui est une liste de bilans qualité (donc d'objets QR_matrix).

is.QR_matrix() et is.mQR_matrix() permettent de tester si un objet est un bilan qualité ou une liste de bilans qualité.

Un objet de type QR_matrix est une liste de trois paramètres :

• le paramètre modalities est un data.frame contenant un ensemble de variables sous forme catégorielle (par défaut : Good, Uncertain, Bad, Severe).

• le paramètre values est un data.frame contenant les valeurs associées aux indicateurs présents dans modalities (i.e. : p-valeurs, statistiques, etc.), ainsi que des variables qui n'ont pas de modalité (i.e. : fréquence de la série, modèle ARIMA, etc).

• le paramètre score_formula contient la formule utilisée pour calculer le score (une fois le calcul réalisé).

Value

QR_matrix() crée et renvoie un objet QR_matrix. mQR_matrix() crée et renvoie un objet mQR_matrix (c'est-à-dire une liste d'objets QR_matrix). is.QR_matrix() et is.mQR_matrix() renvoient des valeurs booléennes (TRUE ou FALSE).

Ajout d'un indicateur dans les objets QR_matrix

Description

Permet d'ajouter un indicateur dans les objets QR_matrix.

Arguments

Details

La fonction add_indicator() permet d'ajouter un indicateur dans la matrice des valeurs du bilan qualité. L'indicateur n'est donc pas ajouté dans la matrice des modalités et ne peut être utilisé dans le calcul du score (sauf pour le pondérer). Pour l'utiliser dans le calcul du score, il faudra d'abord le recoder avec la fonction recode_indicator_num.

L'indicateur à ajouter peut être sous deux formats : vector ou data.frame. Dans les deux cas, il faut que les valeurs à ajouter puissent être associées aux bonnes séries dans la matrice du bilan qualité :

• dans le cas d'un vector, les éléments devront être nommés et les noms doivent correspondre à ceux présents dans le bilan qualité (variable "series") ;

• dans le cas d'un data.frame, il devra contenir une colonne "series" avec les noms des séries correspondantes.

Value

Cette fonction renvoie le même objet, enrichi de l'indicateur choisi. Ainsi, si l'entrée x est une matrice QR, un objet de la classe QR_matrix est renvoyé. Si le code d'entrée x est une matrice mQR, un objet de la classe mQR_matrix est renvoyé.

Calcul d'un score global

Description

Permet de calculer un score global à partir d'un bilan qualité

Arguments

Details

La fonction compute_score permet de calculer un score à partir des modalités d'un bilan qualité. Pour cela, chaque modalité est associée à un poids défini par le paramètre modalities. Ainsi, le paramètre par défaut étant c("Good", "Uncertain", "Bad","Severe"), la valeur "Good" sera associée à la note 0, la valeur "Uncertain" sera associée à la note 1, la valeur "Bad" sera associée à la note 2 et la valeur "Bad" sera associée à la note 3. Le calcul du score se fait grâce au paramètre score_pond, qui est un vecteur numérique nommé contenant des poids et dont les noms correspondent aux variables de la matrice des modalités à utiliser dans le score. Ainsi, avec le paramètre score_pond = c(qs_residual_sa_on_sa = 10, f_residual_td_on_sa = 5) le score sera calculé à partir des deux variables qs_residual_sa_on_sa et f_residual_td_on_sa. Les notes associées aux modalités de la variable qs_residual_sa_on_sa seront multipliées par 10 et celles associées à la variable f_residual_td_on_sa seront multipliées par 5. Dans le calcul du score, certaines variables peuvent être manquantes: pour ne pas prendre en compte ces valeurs dans le calcul, il suffit d'utiliser le paramètre na.rm = TRUE. Le paramètre normalize_score_value permet de normaliser les scores. Par exemple, si l'on souhaite avoir des notes entre 0 et 20, il suffit d'utiliser le paramètre normalize_score_value = 20. Le paramètre n_contrib_score permet d'ajouter de nouvelles variables à la matrice des valeurs du bilan qualité dont les valeurs correspondent aux noms des variables qui contribuent le plus au score de la série. n_contrib_score est un entier égal au nombre de variables contributrices que l'on souhaite exporter. Par exemple, pour n_contrib_score = 3, trois colonnes seront créées et elles contiendront les trois plus grandes contributrices au score. Les noms des nouvelles variables sont i_highest_score, i correspondant au rang en terme de contribution au score (1_highest_score contiendra les noms des plus grandes contributrices, 2_highest_score des deuxièmes plus grandes contributrices, etc). Seules les variables qui ont une contribution non nulle au score sont prises en compte. Ainsi, si une série a un score nul, toutes les colonnes i_highest_score associées à cette série seront vides. Et si une série a un score positif uniquement du fait de la variable "m7", alors la valeur correspondante à la variable 1_highest_score sera égale à "m7" et celle des autres variables i_highest_score seront vides. Certains indicateurs peuvent n'avoir de sens que sous certaines conditions. Par exemple, le test d'homoscédasticité n'est valide que si les résidus sont indépendants et les tests de normalité, que si les résidus sont indépendants et homoscédastiques. Le paramètre conditional_indicator permet de prendre cela en compte en réduisant, sous certaines conditions, à 1 le poids de certains variables. C'est une list contenant des listes ayant 3 éléments :

• "indicator" : nom de la variable pour laquelle on veut ajouter des conditions

• "conditions" : nom des variables que l'on utilise pour conditionner

• "conditions_modalities" : modalités qui doivent être vérifiées pour modifier le poids Ainsi, avec le paramètre conditional_indicator = list(list(indicator = "residuals_skewness", conditions = c("residuals_independency", "residuals_homoskedasticity"), conditions_modalities = c("Bad","Severe"))), on réduit à 1 le poids de la variable "residuals_skewness" lorsque les modalités du test d'indépendance ("residuals_independency") ou du test d'homoscédasticité ("residuals_homoskedasticity") valent "Bad" ou "Severe".

Value

Un objet de type QR_matrix ou mQR_matrix.

Examples

# Chemin menant au fichier demetra_m.csv
demetra_path <- file.path(
    system.file("extdata", package = "JDCruncheR"),
    "WS/ws_ipi/Output/SAProcessing-1",
    "demetra_m.csv"
)

# Extraire le bilan qualité à partir du fichier demetra_m.csv
QR <- extract_QR(demetra_path)

# Compute the score
QR <- compute_score(QR, n_contrib_score = 2)
print(QR)

# Extraire les modalités de la matrice
QR[["modalities"]][["score"]]

Export des objets QR_matrix dans un fichier Excel

Description

Permet d'exporter un bilan qualité dans un fichier Excel.

Arguments

Value

Renvoie de manière invisible (via invisible(x)) un objet de classeur créé par XLConnect::loadWorkbook() pour une manipulation ultérieure.

Export des objets mQR_matrix dans des fichiers Excel

Description

Permet d'exporter dans des fichiers Excel une liste de bilan qualité

Arguments

Value

Renvoie de manière invisible (via invisible(x)) le même objet mQR_matrix que x.

Extraction d'un bilan qualité

Description

Permet d'extraire un bilan qualité à partir du fichier CSV contenant la matrice des diagnostics.

Arguments

Details

La fonction permet d'extraire un bilan qualité à partir d'un fichier csv contenant l'ensemble des diagnostics (généralement fichier demetra_m.csv).

Ce fichier peut être obtenu en lançant le cruncher (cruncher ou cruncher_and_param) avec l'ensemble des paramètres de base pour les paramètres à exporter et l'option csv_layout = "vtable" (par défaut) pour le format de sortie des fichiers csv (option de cruncher_and_param ou de create_param_file lors de la création du fichier de paramètres).

Le résultat de cette fonction est un objet QR_matrix qui est une liste de trois paramètres :

• le paramètre modalities est un data.frame contenant un ensemble de variables sous forme catégorielle (Good, Uncertain, Bad, Severe).

• le paramètre values est un data.frame contenant les valeurs associées aux indicateurs présents dans modalities (i.e. : p-valeurs, statistiques, etc.) ainsi que des variables qui n'ont pas de modalité (fréquence de la série et modèle ARIMA).

• le paramètre score_formula est initié à NULL : il contiendra la formule utilisée pour calculer le score (si le calcul est fait).

Si x est fourni, les arguments fichier et matrix_output_file sont ignorés. L'argument fichier désigne également le chemin vers le fichier qui contient la matrice de diagnostic (qui peut être importée en parallèle dans R et utilisée avec l'argument x).

Value

Un objet de type QR_matrix.

Examples

# Chemin menant au fichier demetra_m.csv
demetra_path <- file.path(
    system.file("extdata", package = "JDCruncheR"),
    "WS/ws_ipi/Output/SAProcessing-1",
    "demetra_m.csv"
)

# Extraire le bilan qualité à partir du fichier demetra_m.csv
QR <- extract_QR(file = demetra_path)

print(QR)

# Extraire les modalités de la matrice
QR[["modalities"]]
# Or:
QR[["modalities"]]

Extraction du score

Description

Permet d'extraire le score des objets QR_matrix ou mQR_matrix.

Arguments

Details

Pour les objets QR_matrix, le score renvoyé est soit l'objet NULL si aucun score n'a été calculé, soit un vecteur. Pour les objets mQR_matrix, c'est une liste de scores (NULL ou un vecteur).

Value

extract_score() renvoie un data.frame avec deux colonnes : le nom de la série et son score.

Examples

# Chemin menant au fichier demetra_m.csv
demetra_path <- file.path(
    system.file("extdata", package = "JDCruncheR"),
    "WS/ws_ipi/Output/SAProcessing-1",
    "demetra_m.csv"
)

# Extraire le bilan qualité à partir du fichier demetra_m.csv
QR <- extract_QR(demetra_path)

# Calculer le score
QR1 <- compute_score(x = QR, n_contrib_score = 5)
QR2 <- compute_score(
    x = QR,
    score_pond = c(qs_residual_sa_on_sa = 5, qs_residual_sa_on_i = 30,
                   f_residual_td_on_sa = 10, f_residual_td_on_i = 40,
                   oos_mean = 30, residuals_skewness = 15, m7 = 25)
)
mQR <- mQR_matrix(list(a = QR1, b = QR2))

# Extraire les scores
extract_score(QR1)
extract_score(mQR)

Affichage des objets QR_matrix et mQR_matrix

Description

Pour afficher un objet QR_matrix ou mQR_matrix.

Arguments

Value

la méthode print imprime un objet mQR_matrix ou mQR_matrix et le renvoie de manière invisible (via invisible(x)).

Combiner par ligne des objets QR_matrix

Description

Permet de combiner plusieurs objets QR_matrix en combinant par ligne les paramètres modalities et values.

Arguments

Value

rbind.QR_matrix() renvoie un objet QR_matrix.

Examples

# Chemin menant au fichier demetra_m.csv
demetra_path <- file.path(
    system.file("extdata", package = "JDCruncheR"),
    "WS/ws_ipi/Output/SAProcessing-1",
    "demetra_m.csv"
)

# Extraire le bilan qualité à partir du fichier demetra_m.csv
QR <- extract_QR(demetra_path)

# Calculer differents scores
QR1 <- compute_score(QR, score_pond = c(m7 = 2, q = 3, qs_residual_sa_on_sa = 5))
QR2 <- compute_score(QR, score_pond = c(m7 = 2, qs_residual_sa_on_sa = 5))

# Fusionner 2 bilans qualité
try(rbind(QR1, QR2)) # Une erreur est renvoyée
rbind(QR1, QR2, check_formula = FALSE)

Ré-encodage en modalités des variables

Description

Permet d'encoder des variables présentes dans la matrice des valeurs en modalités ajoutables à la matrice des modalités.

Arguments

Value

La fonction recode_indicator_num() renvoie le même objet, enrichi de l'indicateur choisi. Ainsi, si l'entrée x est une matrice QR_matrix, un objet de classe QR_matrix est renvoyé. Si le code d'entrée x est une matrice mQR, un objet de la classe mQR_matrix est renvoyé.

Manipulation de la liste des indicateurs

Description

Permet de retirer des indicateurs (fonction remove_indicators()) ou de n'en retenir que certains (fonction retain_indicators()) d'objets QR_matrix ou mQR_matrix. Le nom des séries (colonne "series") ne peut être enlevé.

Arguments

Value

remove_indicators() renvoie le même objet x réduit par les drapeaux et les variables utilisés comme arguments ... Donc si l'entrée x est une matrice QR_matrix, un objet de la classe QR_matrix est renvoyé. Si le code d'entrée x est une matrice mQR, un objet de la classe mQR_matrix est renvoyé.

Examples

# Chemin menant au fichier demetra_m.csv
demetra_path <- file.path(
    system.file("extdata", package = "JDCruncheR"),
    "WS/ws_ipi/Output/SAProcessing-1",
    "demetra_m.csv"
)

# Extraire le bilan qualité à partir du fichier demetra_m.csv
QR <- extract_QR(demetra_path)

# Calculer le score
QR <- compute_score(x = QR, n_contrib_score = 5)

# Retenir certains indicateurs
retain_indicators(QR, "score", "m7") # Retiens les indicateurs "score" et "m7"
retain_indicators(QR, c("score", "m7")) # Pareil

# Retirer des indicateurs
QR <- remove_indicators(QR, "score") # removing "score"

extract_score(QR) # est NULL car l'indicateur "score a été retiré

Tri des objets QR_matrix et mQR_matrix

Description

Permet de trier les bilans qualité en fonction d'une ou plusieurs variables.

Arguments

Value

L'objet en entrée avec les tables de bilan qualité triées.

Examples

# Chemin menant au fichier demetra_m.csv
demetra_path <- file.path(
    system.file("extdata", package = "JDCruncheR"),
    "WS/ws_ipi/Output/SAProcessing-1",
    "demetra_m.csv"
)

# Extraire le bilan qualité à partir du fichier demetra_m.csv
QR <- extract_QR(demetra_path)

# Calculer le score
QR <- compute_score(QR, n_contrib_score = 2)
print(QR[["modalities"]][["score"]])

# Trier les scores

# Pour trier par ordre croissant sur le score
QR <- sort(QR, sort_variables = "score")
print(QR[["modalities"]][["score"]])

Calcul d'un score pondéré pour chaque observation

Description

Permet de pondérer un score déjà calculé en fonction de variables.

Arguments

Value

L'objet en entrée avec le score recalculé

Examples

# Chemin menant au fichier demetra_m.csv
demetra_path <- file.path(
    system.file("extdata", package = "JDCruncheR"),
    "WS/ws_ipi/Output/SAProcessing-1",
    "demetra_m.csv"
)

# Extraire le bilan qualité à partir du fichier demetra_m.csv
QR <- extract_QR(demetra_path)

# Calculer le score
QR <- compute_score(QR, n_contrib_score = 2)
print(QR)

# Pondérer le score
QR <- weighted_score(QR, 2)
print(QR)

# Extraire le score pondéré
QR[["modalities"]][["score_pond"]]

Get all (default) thresholds

Description

Get all (default) thresholds

Usage

get_thresholds(test_name, default = TRUE)

Arguments

Details

If test_name is missing, all threshold will be returned.

Examples

# Get all default thresholds
get_thresholds(default = TRUE)

# Get all current thresholds
get_thresholds(default = FALSE)

# Get all current thresholds
get_thresholds(test_name = "oos_mean", default = FALSE)

Printing QR_matrix and mQR_matrix objects

Description

To print information on a QR_matrix or mQR_matrix object.

Usage

## S3 method for class 'QR_matrix'
print(x, print_variables = TRUE, print_score_formula = TRUE, ...)

## S3 method for class 'mQR_matrix'
print(x, score_statistics = TRUE, ...)

Arguments

Value

the print method prints a mQR_matrix or mQR_matrix object and returns it invisibly (via invisible(x)).

See Also

Traduction française

Combining QR_matrix objects

Description

Function to combine multiple QR_matrix objects: line by line, both for the modalities and the values table.

Usage

## S3 method for class 'QR_matrix'
rbind(..., check_formula = TRUE)

Arguments

Value

rbind.QR_matrix() returns a QR_matrix object.

See Also

Traduction française

Other QR_matrix functions: export_xlsx(), export_xlsx.QR_matrix(), export_xlsx.mQR_matrix(), extract_QR(), sort(), weighted_score()

Examples

# Path of matrix demetra_m
demetra_path <- file.path(
    system.file("extdata", package = "JDCruncheR"),
    "WS/ws_ipi/Output/SAProcessing-1",
    "demetra_m.csv"
)

# Extract the quality report from the demetra_m file
QR <- extract_QR(demetra_path)

# Compute differents scores
QR1 <- compute_score(QR, score_pond = c(m7 = 2, q = 3, qs_residual_sa_on_sa = 5))
QR2 <- compute_score(QR, score_pond = c(m7 = 2, qs_residual_sa_on_sa = 5))

# Merge two quality report
try(rbind(QR1, QR2)) # Une erreur est renvoyée
rbind(QR1, QR2, check_formula = FALSE)

Converting "values variables" into "modalities variables"

Description

To transform variables from the values matrix into categorical variables that can be added into the modalities matrix.

Usage

recode_indicator_num(
  x,
  variable_name,
  breaks = c(0, 0.01, 0.05, 0.1, 1),
  labels = c("Good", "Uncertain", "Bad", "Severe"),
  ...
)

Arguments

Value

The function recode_indicator_num() returns the same object, enhanced with the chosen indicator. So if the input x is a QR_matrix, an object of class QR_matrix is returned. If the input x is a mQR_matrix, an object of class mQR_matrix is returned.

See Also

Traduction française

Other var QR_matrix manipulation: QR_var_manipulation, add_indicator()

Set values for thresholds

Description

Set values for thresholds

Usage

set_thresholds(test_name, thresholds)

Arguments

Details

If test_name is missing, the argument thresholds is not used and all thresholds will be updated to their default values.

If test_name is not missing, but if the argument thresholds is missing then only the thresholds of the test test_name will be updated to its default values.

Finally, if test_name and thresholds are not missing, then only the thresholds of the test test_name are updated with the value thresholds.

Examples

# Set "m7"
set_thresholds(
    test_name = "m7",
    thresholds = c(Good = 0.8, Bad = 1.4, Severe = Inf)
)

# Set "oos_mean" to default
set_thresholds(test_name = "oos_mean")

# Set all thresholds to default
set_thresholds()

QR_matrix and mQR_matrix sorting

Description

To sort the quality reports on one or several variables

Usage

## S3 method for class 'QR_matrix'
sort(x, decreasing = FALSE, sort_variables = "score", ...)

## S3 method for class 'mQR_matrix'
sort(x, decreasing = FALSE, sort_variables = "score", ...)

Arguments

Value

the input with sorted quality reports

See Also

Traduction française

Other QR_matrix functions: export_xlsx(), export_xlsx.QR_matrix(), export_xlsx.mQR_matrix(), extract_QR(), rbind.QR_matrix(), weighted_score()

Examples

# Path of matrix demetra_m
demetra_path <- file.path(
    system.file("extdata", package = "JDCruncheR"),
    "WS/ws_ipi/Output/SAProcessing-1",
    "demetra_m.csv"
)

# Extract the quality report from the demetra_m file
QR <- extract_QR(demetra_path)

# Compute the score
QR <- compute_score(QR, n_contrib_score = 2)
print(QR[["modalities"]][["score"]])

# Sort the scores

# To sort by ascending scores
QR <- sort(QR, sort_variables = "score")
print(QR[["modalities"]][["score"]])

Weighted score calculation

Description

Function to weight a pre-calculated score

Usage

weighted_score(x, pond = 1L)

Arguments

Value

the input with an additionnal weighted score

See Also

Traduction française

Other QR_matrix functions: export_xlsx(), export_xlsx.QR_matrix(), export_xlsx.mQR_matrix(), extract_QR(), rbind.QR_matrix(), sort()

Examples

# Path of matrix demetra_m
demetra_path <- file.path(
    system.file("extdata", package = "JDCruncheR"),
    "WS/ws_ipi/Output/SAProcessing-1",
    "demetra_m.csv"
)

# Extract the quality report from the demetra_m file
QR <- extract_QR(demetra_path)

# Compute the score
QR <- compute_score(QR, n_contrib_score = 2)

# Weighted score
QR <- weighted_score(QR, 2)
print(QR)

# Extract the weighted score
QR[["modalities"]][["score_pond"]]