Skip to contents

The symbols used in the help pages and vignettes of stability, with their meaning and the argument or result component that holds them. The notation follows one rule throughout: scalars are upper-case letters in normal face (\(P\), \(R\)), indices lower-case italic (\(i, j\)), vectors lower-case bold (\(\mathbf{y}\), \(\boldsymbol{\beta}\)) and matrices upper-case bold (\(\mathbf{X}\), \(\boldsymbol{\Sigma}\)).

Usage

stab_notation(format = c("table", "path", "tex"))

Arguments

format

"table" (default: a data.table with columns symbol (LaTeX), text (plain text), kind (scalar, index, vector, matrix, set, function, operator), meaning and argument), "path" (the path of notation.csv) or "tex" (the path of Notations.tex, the notation appendix used in the articles).

Value

See format.

See also

Other stability utilities: stab_reference(), stab_save(), stab_theme()

Author

Muhammad Yaseen (myaseen208@gmail.com)

Examples

stab_notation(
    format = c("table", "path", "tex")[1]
  )
#>                                                symbol            text     kind
#>                                                <char>          <char>   <char>
#>  1:                                                 G               G   scalar
#>  2:                                                 E               E   scalar
#>  3:                                                 B               B   scalar
#>  4:                                           i, j, k           i j k    index
#>  5:                     \\mathbf{Y} = (\\bar{y}_{ij})               Y   matrix
#>  6: \\bar{y}_{i\\cdot}, \\bar{y}_{\\cdot j}, \\bar{y}   y_i. y_.j y..   scalar
#>  7:                            \\mathbf{Z} = (z_{ij})               Z   matrix
#>  8:                                               I_j             I_j   scalar
#>  9:                                          s^2, f_e          s2 f_e   scalar
#> 10:                                          \\beta_i             b_i   scalar
#> 11:                                         S^2_{d_i}           S2d_i   scalar
#> 12:                                               W_i             W_i   scalar
#> 13:                                       \\sigma^2_i        sigma2_i   scalar
#> 14:                                        \\lambda_n        lambda_n   scalar
#> 15:  \\boldsymbol{\\gamma}_n, \\boldsymbol{\\delta}_n gamma_n delta_n   vector
#> 16:                                                 P               P   scalar
#> 17:                      \\mathbf{g}_i, \\mathbf{e}_j         g_i e_j   vector
#> 18:                                       \\mathbf{a}               a   vector
#> 19:                            \\alpha, Z_{1-\\alpha}         alpha z   scalar
#> 20:                                               P_i             P_i   scalar
#> 21:                              S^{(1)}_i, S^{(2)}_i       S1_i S2_i   scalar
#> 22:                    \\mathbf{A}^\\top, \\mathbf{1}           A^T 1 operator
#>                                                symbol            text     kind
#>                                                <char>          <char>   <char>
#>                                                                                                  meaning
#>                                                                                                   <char>
#>  1:                                                                                  number of genotypes
#>  2:                                                                               number of environments
#>  3:                                                             number of replicates in each environment
#>  4:                                                                     genotype, environment, replicate
#>  5:                                                               table of genotype-by-environment means
#>  6:                                                                genotype, environment and grand means
#>  7:                                              interaction effects (means centred on rows and columns)
#>  8:                                                 environment index, environment mean minus grand mean
#>  9:                                     pooled error mean square of the plots and its degrees of freedom
#> 10:                                              regression slope of genotype i on the environment index
#> 11:                                                            Eberhart and Russell's deviation variance
#> 12:                                                                                  Wricke's ecovalence
#> 13:                                                                          Shukla's stability variance
#> 14:                              n-th singular value (AMMI: of Z; GGE: of the environment-centred means)
#> 15:                                                            genotype and environment singular vectors
#> 16: singular value partition of the GGE biplot: 1 genotype-focused, 0.5 symmetric, 0 environment-focused
#> 17:                                                    GGE biplot points of genotype i and environment j
#> 18:                                                            direction of the average environment axis
#> 19:    risk of a low yield accepted in the safety-first and reliability indices, and the normal quantile
#> 20:                                                                   Lin and Binns' superiority measure
#> 21:                                          Huehn's mean absolute rank difference and variance of ranks
#> 22:                                                                            transpose, vector of ones
#>                                                                                                  meaning
#>                                                                                                   <char>
#>     argument
#>       <char>
#>  1:     .gen
#>  2:     .env
#>  3:     .rep
#>  4:         
#>  5:       .y
#>  6:         
#>  7:         
#>  8:         
#>  9:         
#> 10:         
#> 11:         
#> 12:         
#> 13:         
#> 14:         
#> 15:         
#> 16:     .svp
#> 17:         
#> 18:         
#> 19:    alpha
#> 20:         
#> 21:         
#> 22:         
#>     argument
#>       <char>