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
- modalities
a
data.framecontaining the output variables' modalities (Good, Bad, etc.)- values
a
data.framecontaining the output variables' values (test p-values, test statistics, etc.) Therefore, the values data frame can contain more variables than the data framemodalities.- score_formula
the formula used to calculate the series score (if defined).
- x
a
QR_matrixobject, amQR_matrixobject or a list ofQR_matrixobjects.- ...
objects of the same type as
x.
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).
Details
AQR_matrix object is a list of three items:
modalities, adata.framecontaining a set of categorical variables (by default: Good, Uncertain, Bad, Severe).values, adata.framecontaining the values corresponding to themodalitiesindicators (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_formulacontains the formula used to calculate the series score (once the calculus is done).