MCA Variables
=============

Variables for the :doc:`/api/spy4cast.spy4cast.MCA` methodology that can be accessed for plotting.


.. table::
    :class: variables-table

    +----------+-----------------------------------------------------------------------------------------------------+------------------+
    | VARIABLE | MEANING                                                                                             | DIMENSION LENGTH |
    +==========+=====================================================================================================+==================+
    | .RUY     | Correlation of the predictor field.                                                                 | y_ns x nm        |
    +----------+-----------------------------------------------------------------------------------------------------+------------------+
    | .RUY_sig | Correlation of the predictor field where pvalue is smaller than alpha.                              | y_ns x nm        |
    +----------+-----------------------------------------------------------------------------------------------------+------------------+
    | .SUY     | Regression in space of the predictor with the singular vector.                                      | y_ns x nm        |
    +----------+-----------------------------------------------------------------------------------------------------+------------------+
    | .SUY_sig | Regression in space of the predictor with the singular vector where pvalue is smaller than alpha.   | y_ns x nm        |
    +----------+-----------------------------------------------------------------------------------------------------+------------------+
    | .RUZ     | Correlation of the predictand field.                                                                | z_ns x nm        |
    +----------+-----------------------------------------------------------------------------------------------------+------------------+
    | .RUZ_sig | Correlation of the predictand field where pvalue is smaller than alpha.                             | z_ns x nm        |
    +----------+-----------------------------------------------------------------------------------------------------+------------------+
    | .SUZ     | Regression in space of the predictand with the singular vector.                                     | z_ns x nm        |
    +----------+-----------------------------------------------------------------------------------------------------+------------------+
    | .SUZ_sig | Regression in space of the predictand with the singular vector where pvalue is smaller than alpha.  | z_ns x nm        |
    +----------+-----------------------------------------------------------------------------------------------------+------------------+
    | .pvalruy | Pvalue of the correlation of the predictor field.                                                   | y_ns x nm        |
    +----------+-----------------------------------------------------------------------------------------------------+------------------+
    | .pvalruz | Pvalue of the correlation of the predictand field.                                                  | z_ns x nm        |
    +----------+-----------------------------------------------------------------------------------------------------+------------------+
    | .Us      | Singular vectors of the predictor field.                                                            | nm x nt          |
    +----------+-----------------------------------------------------------------------------------------------------+------------------+
    | .Vs      | Singular vectors of the predictand field.                                                           | nm x nt          |
    +----------+-----------------------------------------------------------------------------------------------------+------------------+
    | .scf     | Square covariance fraction of the singular values.                                                  | nm               |
    +----------+-----------------------------------------------------------------------------------------------------+------------------+
    | .alpha   | Significance coeficient.                                                                            | 1                |
    +----------+-----------------------------------------------------------------------------------------------------+------------------+

.. table::
    :class: variables-table

    +---------------+------------------------------------------------------------+--------------------------------------------+
    | VARIABLE      | MEANING                                                    | TYPE                                       |
    +===============+============================================================+============================================+
    | .dsy          | Preprocessed dataset that was introduced as predictor.     | Preprocess                                 |
    +---------------+------------------------------------------------------------+--------------------------------------------+
    | .dsz          | Preprocessed dataset that was introduced as predictand.    | Preprocess                                 |
    +---------------+------------------------------------------------------------+--------------------------------------------+