Differences

This shows you the differences between two versions of the page.

--- readme.aireml [2014/07/10 13:29] – shogo
+++ readme.aireml [2019/07/22 22:58] – [Options] shogo
@@ Line 2: / Line 2: @@
 ===== Summary =====
-A modification of REMLF90 for estimating variances with the Average-Information algorithm. Initially written by Shogo Tsuruta in 03/99-07/99.
+A modification of REMLF90 for estimating variances with the Average-Information algorithm. Initially written by Shogo Tsuruta in 03/99-07/99. AIREMLF90 uses a second derivative REML algorithm with extra heuristics, as is described in Jensen et al. (1996-7). For most models, it converges in far fewer rounds than EM-REML as implemented in REMLF90. While typically REMLF90 takes 50-300 rounds to converge, AIREMLF90 converges in 5-15 rounds and to a higher accuracy. The final results will be saved in "airemlf90.log".
 \\
-AIREMLF90 uses a second derivative REML algrithm with extra heuristics, as is described in Jensen et al. (1996-7). For most models, it converges in far fewer rounds than EM-REML as implemented in REMLF90. While typically REMLF90 takes 50-300 rounds to converge, AIREMLF90 converges in 5-15 rounds and to a higher accuracy. For selected models, AI-REML may fail to converge when the covariance matrix is close to non-positive definite. Adjust sensitivity of the program by setting the appropriate tolerance or setting good starting values. The final results will be saved in "AIREMLF90.log".
 \\
 See PREGSF90 with genotypes (SNP) for options.
@@ Line 16: / Line 15: @@
 OPTION maxrounds 1000
 </file>
-Maximum rounds (default 5000). When the number < 2, the program calculates BLUP without iterating REML.
+Maximum rounds (default 5000). When the number = 0, the program calculates BLUP without iterating REML and some statistics (-2logL, AIC, SE for (co)variances, ...).
 <file>
 OPTION EM-REML 10
@@ Line 33: / Line 32: @@
 OPTION sol se
 </file>
-Store solutions and those s.e.
+Store solutions and those standard errors.
+<file>
+OPTION store_pev_pec 6
+</file>
+Store triangular matrices of standard errors and its covariances for correlated random effects such as direct-maternal effects and random-regression effects in "pev_pec_bf90".
 <file>
 OPTION residual
@@ Line 41: / Line 44: @@
 OPTION missing -999
 </file>
-Specify the missing value (default 0).
+Specify the missing value (default 0) in integer.
+<file>
+OPTION constant_var 5 1 2 ...
+</file>
+: effect number\\
+: first trait number\\
+: second trait number\\
+implying the covariance between traits 1 and 2 for effect 5.
 **Heterogeneous residual variances for a single trait**
@@ Line 47: / Line 57: @@
 OPTION hetres_pos 10 11
 </file>
-Specify the position of covariables.
+Specify the column position of (two) covariables in the data file.
 <file>
 OPTION hetres_pol 4.0 0.1 0.1
@@ Line 78: / Line 88: @@
 <file>OPTION se_covar_function <label> <function></file>
-As an alternative of SE, calculate SD for function of (co)variances by repeated sampling of parameters estimates from their asymptotic multivariate normal distribution, following idea presented by Meyer and Houle 2013.\\
+As an alternative of SE, calculate SD for function of (co)variances by repeated sampling of parameters estimates from their asymptotic multivariate normal distribution, following ideas presented by Meyer and Houle 2013.\\
 \\
 ''<label>''\\
@@ Line 86: / Line 96: @@
 A formula to calculate a function of (co)variances to estimate SD. All terms of the function should be written with no spaces.\\
 \\
-Each term of the function corresponds to (co)variance elements and could include any random effects (G, PE, ...) and residual (R) (co)variances.\\
+Each term of the function corresponds to (co)variance elements and could include any random effects (G) and residual (R) (co)variances.\\
 \\
 Notation is with reference to the effect number and the trait number (''G_eff1_eff2_trt1_trt2'') that indicate the element of the (co)variance matrix for random effect ''eff1'' and ''eff2'' and ''trt1'' and ''trt2'',\\
@@ Line 114: / Line 124: @@
 <file>OPTION samples_se_covar_function <n></file>
 Set the number of samples to calculate SE for function of (co)variances.\\
-default value 5000
+default value 10000
 <file>OPTION out_se_covar_function</file>
 Indicate to store in file samples of (co)variances function for postprocessing (histogram, etc.)
+===== Tricks =====
+When the covariance matrix is close to non-positive definite, the AIREMLF90 may not converge.
+There are two options you might want to try:
+. change the tolerance value (xx) in the option:
+OPTION tol xx
+to a very strict value (e.g., 1d-20) or a lenient value (1d-06).
+. use an option to use EM-REML inside AI-REML:
+OPTION EM-REML xx
+where xx is the number of iterations for EM-REML you expect to get a good starting value for AI-REML. After running xx rounds with EM-REML, the AIREMLF90 program will automatically switch from EM-REML to AI-REML using the last estimate from EM-REML as a starting value for AI-REML.