extract_QR: Extraction of a quality report

In AQLT/JDCruncheR: Interface between the JDemetra+ cruncher and R, and quality report generator

Extraction of a quality report

Description

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

Usage

extract_QR(matrix_output_file, sep = ";", dec = ",")

Arguments

matrix_output_file	the csv file containing the diagnostics matrix.
sep	the separator used in the csv file (by default, sep = ";")
dec	the decimal separator used in the csv file (by default, dec = ",")

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.

Value

a QR_matrix object.

See Also

Traduction française

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

Examples

## Not run: 
QR <- extract_QR()
print(QR)
# To extract the modalities matrix:
QR$modalities
# Or:
QR[["modalities"]]

## End(Not run)

AQLT/JDCruncheR documentation built on March 20, 2024, 2:32 p.m.