Updated to reflect addition of verifyCorrelationMatrix to mxData.
[openmx:proteins-proteins-openmx.git] / CHANGES
1 trunk
2 =====
3 * added verifyCorrelationMatrix to mxData. See http://openmx.psyc.virginia.edu/issue/2011/06/error-checking-correlation-matrices
4 * added omxSelectRowsAndCols, omxSelectRows and omxSelectCols documentation
5 * fixed model flattening to keep track of confidence intervals in submodels
6 * fixed a bug in omxParallelCI() introduced by previous change
7
8 Beta Release 999.0.0-1661 (May 20, 2011)
9 ========================================
10 * turn off jiggling of free parameters with starting values of 0.0 when useOptimizer=FALSE
11 * allow non-RAM objective functions in RAM model
12 * change model type names to 'default' and 'RAM'
13 * no longer explicitly transforming RAM + raw data models into FIML models
14 * fixed bug in MxMatrix indexing operator
15
16 Pre-Release 999.0.0-1609 (April 7, 2011)
17 ========================================
18 * added argument 'threshnames' to mxFIMLObjective()
19 * eliminated "initialize" method for MxMatrix objects
20 * added "omxCreateMatrix" method for MxMatrix objects
21 * renaming majority of omx* functions to imx* functions. See http://openmx.psyc.virginia.edu/thread/761
22 * added error checking to mxOption() function
23 * added "Optimality tolerance" to mxOption() selection
24 * added 'lbound' and 'ubound' columns to summary() output of free parameters
25 * added asterisks to the 'lbound' and 'ubound' columns when feasibility tolerance is met
26 * added "omxNot" function to the set of available mxAlgebra() function
27 * added "omxSelectRows", "omxSelectCols", and "omxSelectRowsAndCols" as mxAlgebra operators()
28 * updated interface of mxRowObjective
29 * in ML objective: expected covariance matrix and observed covariance matrix must have identical dimnames
30 * in RAM and ML objectives: the observed means vector must have column names
31 * added "mean" function to the set of available mxAlgebra() functions
32 * added slots "expCov" and "expMean" to the MxRAMObjective function
33 * added useOptimizer option to mxRun.
34 * added error checking in frontend and backend for non-positive-definite observed covariance matrices
35 * added "omxGreaterThan", "omxLessThan", "omxApproxEquals", "omxAnd", and "omxOr" operators to the set of mxAlgebra() operators
36 * error checking for model[[1]] or model[[TRUE]]
37 * error checking in the front-end whether more than 20 ordinal columns are present in a data set
38 * improved performance in the front-end in mxModel() for adding paths to RAM models
39 * print name of algebra when operator has too few or too many arguments
40
41 Pre-Release 999.0.0-1527 (January 6, 2011)
42 ==========================================
43 * added mxErrorPool() function and R documentation.
44 * added Apache license information to all R documentation files.
45 * new implementation of mxEval().
46 * new argument 'defvar.row' to mxEval().  See ?mxEval.
47 * handling definition variables for (I - A) ^ - 1 speedup
48 * handling square bracket labels for (I - A) ^ - 1 speedup
49 * added argument 'free' to omxGetParameters.  See ?omxGetParameters.
50 * added argument 'strict' to omxSetParameters.  See ?omxSetParameters.
51 * eliminated warnings for confidence interval optimization codes
52 * added "..." argument to mxRObjectiveFunction()
53 * added 'excludeself' argument to mxPath() function
54 * fix memory leak in RAM objective function
55 * removed dependency to MBESS library in R documentation
56 * added more descriptive error message when thresholds are not sorted
57 * incorporated NaN unsafe matrix-matrix multiplication (dgemm) from R <= 2.11.1
58 * incorporated NaN unsafe matrix-vector multiplication (dgemv) from R <= 2.11.1
59 * return NA in mxVersion() if "OpenMx" cannot be found
60 * fix infinite loop in objective function transformations
61 * added initialization to load OpenMx on swift workers
62 * implemented omxParallelCI() to calculate confidence intervals in parallel
63 * only calculating CIs for upper triangle of symmetric matrices
64 * cleanup appearance of transient MxMatrix objects in error messages
65 * fix bug with very large number of omxUntitledName() objects
66 * added optional argument CPUS=n to "make test" target
67 * change snowfall interface to use sfClusterApplyLB()
68 * storing raw data in row-major order, and copying contiguous data rows
69 * fix bug in mxModel() when using remove = TRUE
70
71 Release 1.0.0-1448 (September 30, 2010)
72 =======================================
73 * added missing entries to demo 00INDEX file
74
75 Release 0.9.2-1446 (September 26, 2010)
76 =======================================
77 * added growth mixture models to user guide
78 * added initial Swift hook in omxLapply() - currenly activated only for mxRun calls
79 * fixed a bug in mxRename() when encountering symbol of missingness
80 * bugfix for crash when '*' is used instead of '%*%'
81 * feature removal: square brackets in MxMatrix labels now accept only literal values
82 * bugfix for definition variables used in mxRowObjective (which is still experimental)
83 * bugfix for (I - A) ^ -1 speedup with FIML optimization
84
85 Release 0.9.1-1421 (September 12, 2010)
86 =======================================
87 * fixed a bug in -2 LL calculation in RAM models with definition variables and raw data
88
89 Release 0.9.0-1417 (September 10, 2010)
90 =======================================
91 * improved error messages for non 1 x n means vectors in FIML and ML
92 * fixed a performance bug that was forcing too many recalculations of the covariance matrix in FIML optimizations.
93 * defualt behavior is to disable standard error calculations when model contains nonlinear constraints
94 * improved error messages for NA values in definition variables
95 * added error message when expected covariance dimnames and threshold dimnames do not contain the same elements.
96 * fixed a bug when mxRename() encounters a numeric or character literal.
97 * new chapters added to OpenMx user guide.
98 * fixed a bug in -2 log likelihood calculation with missing data
99
100 Release 0.5.2-1376 (August 29, 2010)
101 ====================================
102 * improved error messages when identical label is applied to free and fixed parameters
103 * added 'onlyFrontend' optional argument to mxRun() function.  See ?mxRun.
104 * disabling cbind() and rbind() transformations as they are broken.
105
106 Release 0.5.1-1366 (August 22, 2010)
107 ====================================
108 * added error detection when multiple names are specified in mxMatrix(), mxAlgebra(), etc.
109 * removed 'digits' argument from mxCompare.  Target behavior of argument was unclear.  See ?mxCompare
110 * more informative error messages for 'dimnames' argument of objective functions
111 * more informative error messages when constraints have wrong dimensions
112 * improved error detected for 'nrow' and 'ncol' arguments of mxMatrix() function
113 * fixed a bug in ordinal FIML objective functions with non-used continuous data
114
115 Release 0.5.0-1353 (August 08, 2010)
116 ====================================
117 * calculating cycle length of RAM objective functions
118 * bugfix: preserve rownames when converting data.frame columns to numeric values
119 * 'nrow' and 'ncol' arguments now supercede matrix dimensions in mxMatrix()
120 * add boolean argument 'vector' to mxRAMObjective() for returning the vector of likelihoods
121 * added demo(OneFactorModel_LikelihoodVector) as example of 'vector=TRUE' in RAM model
122 * cbind() and rbind() inside MxAlgebra expressions with all arguments as MxMatrix objects are themselves transformed into MxMatrix objects
123 * bugfix with square bracket substitution
124 * finishing implementing sorting of raw data in mxFIMLObjective()
125 * added 'RAM Optimization' and 'RAM Max Depth' to model options.  See ?mxOption
126 * added support for linux x86_64 with gcc 4.1.x
127
128 Release 0.4.1-1320 (June 12, 2010)
129 ==================================
130 * confidence interval optimizations now jitter if they can't get started
131 * added error checking for dimensions of expected means in ML + FIML objectives
132 * check for missing observed means when using (optional) expected means in ML
133 * added citation("OpenMx") information
134
135 Release 0.4.0-1313 (June 09, 2010)
136 ==================================
137 * fixed bug in calculation of confidence intervals around non-objective values
138 * checking for partial square bracket references on input
139 * fixed error reporting for non-positive-definite covariances in FIML
140 * implemented initial sorting-based speedup for FIML objectives
141 * added 'No Sort Data' to mxOptions()
142 * eliminated getOption('mxOptimizerOptions') and getOption('mxCheckpointOptions') 
143 * added getOption('mxOptions')
144 * error messages for illegal names provide function call information
145 * added 'estimates' column to confidence intervals in summary() of model
146 * fixed bug so checkpointing will work in R 2.9.x series
147 * fixed bug so mxRename() works on confidence interval specification
148 * renaming 'estimates' column of confidence interval summary output to 'estimate'
149
150 Release 0.3.3-1264 (May 24, 2010)
151 =================================
152 * confidence interval frontend was requesting nonexistent matrices
153 * omxNewMatrixFromMxMatrix() assumed input was always integer vector S-expression
154 * confidence intervals mislabeling free parameter names
155
156 Release 0.3.2-1263 (May 22, 2010)
157 =================================
158 * added 'newlabels' argument to omxSetParameters() function
159 * now throwing errors to the user when detected from the backend in mxRun()
160 * checkpointing mechanism implemented - mxRun(model, checkpoint = TRUE)
161 * never computing confidence intervals for matrix cells where free = FALSE (all bets are off on algebras)
162 * added mxOption(model, "CI Max Iterations", value) 
163 * added documentation for mxRestore() function
164 * default expected means vectors are no longer generated
165
166 Release 0.3.1-1246 (May 09, 2010)
167 =================================
168
169 * new arguments to mxRun() for checkpointing and socket communication (doesn't work yet)
170 * throw an error if FIML objective has thresholds but observed data is not a data.frame object.
171 * bugfix for R version 2.11.0 is detecting as.symbol("") character as missing function parameter
172 * mxFactor() function accepts data.frame objects
173 * added mxCI() function to calculate likelihood-based confidence intervals
174 * mxCompare() shows model information for base models
175 * added flag all=[TRUE|FALSE] to mxCompare() function
176 * 'SaturatedLikelihood' argument to summary() function will accept MxModel object
177
178 Release 0.3.0-1217 (Apr 20, 2010)
179 =================================
180
181 new features
182 ------------
183 * implemented new ordinal data interface http://openmx.psyc.virginia.edu/thread/416#comment-1421 (except for 'means=0' component)
184 * added mxFactor() function (see ?mxFactor for help)
185 * added R documentation for rvectorize() and cvectorize()
186 * implemented eigenvalues and eigenvectors
187 * added 'numObs', 'numStats' arguments to mxAlgebraObjective()
188 * added 'numObs', 'numStats' arguments to summary()
189
190 changes to interface
191 --------------------
192 * mxConstraint("A", "=", "B") is now written as mxConstraint(A == B)
193 * renaming 'cov' argument to 'covariance' in omxMnor()
194 * renaming 'lbounds' argument to 'lbound' in omxMnor()
195 * renaming 'ubounds' argument to 'ubound' in omxMnor()
196 * renaming 'cov' argument to 'covariance' in omxAllInt()
197 * argument 'silent = TRUE' to mxRun() will no longer suppress warnings
198 * argument 'suppressWarnings = TRUE' to mxRun() will suppress warnings
199
200 bug fixes
201 ---------
202 * added error checking for mxBounds() with undefined parameter names
203 * improving error messages in mxMatrix() function
204 * fixed aliasing bug in mxAlgebra() with external variables and constant values
205
206 internal
207 --------
208 * added directory to repository for nightly tests ("make nightly")
209 * performance improvement to namespace conversion
210 * changing MxPath data structure from a list to an S4 object
211 * new signature for omxSetParameters(model, labels, free, values, lbound, ubound, indep)
212 * checked in implementation of mergesort
213 * changed mxCompare() signature to mxCompare(base, comparison, digits = 3)
214
215
216 Release 0.2.10-1172 (Mar 14, 2010)
217 ==================================
218 * bugfix for assigning default data name when default data does not exist
219 * bugfix for sharing/unsharing data to a three-level hierarchy
220 * bugfix for error reporting in bad matrix access, uncalculated std. errors, and poor omxAllint thresholds
221 * implemented rvectorize, cvectorize algebra functions: vectorize by row, and vectorize by column
222 * not allowing the following forbidden characters in names or labels: "+-!~?:\*/^%<>=&|$"
223 * added timestamp to summary() output
224 * reimplemented summary() function to handle unused data rows, and independent submodels
225 * reimplemented names(model), model$foo, and model$foo <- value to return all components of a model tree
226 * started work on an "OpenMx style guide" section to the User Guide.
227 * fix documentation + demo errors brought to our attention by dbishop
228
229 Release 0.2.9-1147 (Mar 04, 2010)
230 =================================
231 * bugfix for ordinal FIML with columns that are not threshold columns
232 * bugfix for detection of algebraic cycles when multiple objective functions are present
233 * test cases included for standard error calculation
234 * enabled standard error calculation by default
235
236 Release 0.2.8-1133 (Mar 02, 2010)
237 =================================
238 * bugfix for memory leak behavior in kronecker product calculation
239 * implemented kronecker exponentiation operator %^%.
240 * actually updating means calculations in ordinal FIML models
241 * removing standard errors from summary() until they are computed correctly
242
243 Release 0.2.7-1125 (Feb 28, 2010)
244 =================================
245 * added 'unsafe' argument to mxRun function.  See ?mxRun for more information.
246 * bugfix for filtering definition variable assignment to current data source.
247 * bugfix for using data.frame with integer type columns that are not factors.
248
249 Release 0.2.6-1114 (Feb 23, 2010)
250 =================================
251 * implemented omxAllInt, use ?omxAllInt for R help on this function
252 * implemented omxMnor, use ?omxMnor for R help on this function
253 * added option to calculate Hessian after optimization.  See ?mxOption for R help.
254 * added option to calculate standard errors after optimization.  See ?mxOption for R help.
255 * added R documentation for vech, vechs, vec2diag, and diag2vec
256 * performance improvements for independent submodels
257 * added 'silent=FALSE' argument to mxRun() function
258 * added R documentation for omxApply(), omxSapply(), and omxLapply()
259 * wrote mxRename() and added R documentation for function
260 * added 'indep' argument to summary() to ignore independent submodels (see ?summary)
261 * added 'independentTime' to summary() output. Wall clock time for independent submodels.
262 * added 'wallTime' and 'cpuTime' to summary() output. Total wall clock time and total cpu time.
263 * implemented ':' operator for MxAlgebra expressions. 1:5 returns the vector [1,2,3,4,5]
264 * implemented subranges for '[' operator in MxAlgebra expressions. foo[1:5,] is valid inside algebra.
265 * added omxGetParameters, omxSetParameters, omxAssignFirstParameters.  Use ? for documentation.
266 * renamed all objective function generic functions from omxObj* to genericObj*
267 * enumerated OpenMx and NPSOL options in ?mxOption documentation
268 * implemented foo[x,y] and foo[x,y] <- z for MxMatrix objects
269
270
271 Release 0.2.5-1050 (Jan 22, 2010)
272 =================================
273 * added 'mxVersion' slot to output of summary() function.
274 * added documentation of summary() function.
275 * set default function precision for ordinal FIML evaluation to "1e-9"
276 * not throwing an error on mxMatrix('Full', 3, 3, labels = c(NA, NA, NA))
277 * applying identical error checking to single thresholds matrix and single thresholds algebra
278 * implemented generic method names() for MxModel objects.
279 * implemented vec2diag() and diag2vec() matrix algebra functions.
280
281 Release 0.2.4-1038 (Jan 15, 2010)
282 =================================
283 * definition variables can now be used inside algebra expressions
284 * definition variables inside of MxMatrices will populate to the 1st row before conformability checking. In plain english: you do not need to specify the starting values for definition variables.
285 * the square-bracket operator when used in MxMatrix labels is no longer restricted to constants for the row and column.  The row and column arguments will accept any term that evaluates to a scalar value or a (1 x 1) matrix.
286 * summary() on a model returns a S3 object.  Behaves like summary() in stats package.
287 * eliminated UnusualLabels.R test case.  Too many problems with windows versus OS X versus linux.
288 * implemented vech() and vechs() functions: half-vectorization and strict half-vectorization
289 * fixed bug in ordinal FIML when # of data columns > # of thresholds
290 * added 'frontendTime' and 'backendTime' values to summary() output. They store the elapsed time of a model in the R front-end and C back-end, respectively.
291 * created a name space for the OpenMx library. Only mx**() and omx**() functions should be exported to the user, plus several miscellaneous matrix functions and S4 generic functions.
292 * corrected 'observedStatistics' output of summary() to exclude definition variables
293 * corrected 'observedStatistics' output of summary() count the number of equality constraints
294
295 Release 0.2.3-1006 (Dec 04, 2009)
296 =================================
297 * added 'vector' argument to mxFIMLObjective() function. Specifies whether to return the likelihood vector (if TRUE) or the sum of log likelihoods (if FALSE). Default value is FALSE.
298 * renamed omxCheckEquals() to omxCheckIdentical(). omxCheckIdentical() call "identical" so that NAs can be compared.
299 * added checking of column names of F and M matrices in RAM objective functions.
300 * added 'dimnames' argument to mxRAMObjective() function. Populates the column names of F and M matrices.
301 * added square bracket operator to MxAlgebra expressions.  A[x,y] or A[,y] or A[x,] or A[,] are valid.
302 * square bracket operator supports row and column string arguments.
303 * mxModel(remove=TRUE) accepts both character names or S4 named entities.
304 * added support for x86_64 on OS X 10.6 (snow leopard)
305 * fixed support for x86_64 on Ubuntu 9.10 (gcc 4.4)
306 * throw error message when inserting a named entity into a model with an identical name
307 * added Anthony William Fairbank Edwards "Likelihood" (1972; 1984) A, B, O blood group example to online documentation
308
309 Release 0.2.2-951 (Oct 29, 2009)
310 ================================
311 * omxGraphviz() either prints to stdout or to a filename
312 * updated omxGraphviz() to draw an arrow if (value != 0 || free == TRUE || !is.na(label))
313 * omxGraphviz() returns a character string invisibly
314 * error checking for bogus definition variables
315 * summary() uses matrix dimnames by default, use options('mxShowDimnames'=FALSE) to disable
316 * added support for gcc 4.4 (Ubuntu 9.10) on x86 and x86_64 architectures
317 * created R documention for omxGraphviz() function
318 * generalized dependency specification for objective functions (omxObjDependencies)
319 * fixed cross-reference links in User Guide
320
321 Release 0.2.1-922 (Oct 10, 2009)
322 ================================
323 * checked observed data for dimnames on ML objective functions
324 * using dimnames= argument to mxMLObjective() and mxFIMLObjective()
325   propagates to MxMatrix objects on output.
326 * bug fix for error message where model name is incorrect
327 * updated user guide in response to feedback from beta testers
328 * incremented version number to 0.2.1-922 to sync demos and user guide
329
330 Release 0.2.0-905 (Oct 06, 2009)
331 ================================
332 * several of the twin model demo examples have been recoded.
333 * fixed bug with non-floating point matrices.
334 * more error checking for mxPath().
335 * tools/mxAlgebraParser.py will convert Mx 1.0 algebra expressions (Python PLY library is required).
336 * renamed "parameter estimate" column to "Estimate" and "error estimate" to "Std.Error" in summary().
337 * added 'dimnames' argument to mxFIMLObjective() and mxMLObjective().
338 * error checking for RAM models with non-RAM objective functions.
339
340 Release 0.1.5-851 (Sep 25, 2009)
341 ================================
342 * improved error messages on unknown identifier in a model (beta tester issue)
343 * fixed bug in mxMatrix() when values argument is matrix and byrow=TRUE
344 * implemented square-bracket substitution for MxMatrix labels
345 * fixed a bug in computation of omxFIMLObjective within an algebra when definition variables are used
346 * significant alterations to back-end debugging flags
347 * tweaked memory handling in back-end matrix copying
348 * added support for x86_64 linux with gcc 4.2 and 4.3
349
350 Release 0.1.4-827 (Sep 18, 2009)
351 ================================
352 * added checking and type coercion to arguments of mxPath() function (a beta tester alerted us to this)
353 * moved matrices into submodels in UnivariateTwinAnalysis_MatrixRaw demo
354 * added Beginners Guide to online documentation
355 * mxRun() issues an error when the back-end reports a negative status code
356 * named entities and free or fixed parameter names cannot be numeric values
357 * constant literals are allowed inside mxAlgebra() statements, e.g. mxAlgebra(1 + 2 + 3)
358 * constant literals can be of the form 1.234E+56 or 1.234e+56.
359 * type checking added to mxMatrix arguments (prompted by a forum post)
360 * mxPath() issues an error if any of the arguments are longer than the number of paths to be generated
361 * data frames are now accepted at the back-end
362 * FIML ordinal objective function is now working. Still a bit slow and inelegant, but working
363 * FIML ordinal now accepts algebras and matrices. dimnames of columns must match data elements
364 * implemented free parameter and fixed parameter substitution in mxAlgebra statements
365 * implemented global variable substitution in mxAlgebra statements
366 * turned off matrix and algebra substitution until a new proposal is decided
367 * snow and snowfall are no longer required packages
368 * added cycle detection to algebra expressions
369 * mxEval() with compute = TRUE will assign dimnames to algebras
370 * added dimnames checking of algebras in the front-end before optimization is called
371 * added 'make rproftest' target to makefile
372
373 Release 0.1.3-776 (Aug 28, 2009)
374 ================================
375 * mxEvaluate() was renamed to mxEval() after input from beta testers on the forums.
376 * new function mxVersion that prints out the current version number (beta tester request).
377 * When printing OpenMx objects, the @ sign is used where it is needed if you would want to print part of the object (beta tester request).
378 * now supports PPC macs.
379 * implemented AIC, BIC and RMSEA calculations.
380 * mxMatrix documentation now talks about lower triangular matrices (beta tester request).
381 * fixed bugs in a number of demo scripts.
382 * added chi-square and p-value patch from beta tester Michael Scharkow.
383 * added comments to demo scripts.
384 * fixed a bug in the quadratic operator  (a beta tester alerted us to this).
385 * means vectors are now always 1xn matrices (beta tester request).
386 * added an option "compute" to mxEval() to precompute matrix expressions without going to the optimizer.
387 * Matrix algebra conformability is now tested in R at the beginning of each mxRun().
388 * named entities (i.e. mxMatrices, mxAlgebras, etc.) can no longer have the same name as the label of a free parameter.  (This seems obscure, but you will like what we do with it in the next version!)
389 * can use options(mxByrow=TRUE) in the R global options if you always read your matrices in with the byrow=TRUE argument.  Saves some typing.  (beta tester request)
390 * fixed the standard error estimates summary.
391 * added mxVersion() function to return the version number (as a string).
392
393 Release 0.1.2-708 (Aug 14, 2009)
394 ================================
395 * Added R help documentation for omxCheckCloseEnough(), omxCheckWithinPercentError(), 
396         omxCheckTrue(), omxCheckEquals(), and omxCheckSetEquals()
397
398 * (mxMatrix) Fixed a bug in construction of symmetric matrixes.
399     - now supports lower, standardized, and subdiagonal matrices.
400
401 Release 0.1 (Aug 03, 2009)
402 ==========================
403 * (mxEvaluate) mxEvaluate translates MxMatrix references, MxAlgebra references,  MxObjectiveFunction references, and label references.
404
405 * (mxOptions) added 'reset' argument to mxOptions()
406
407 * (mxPath) renamed 'start' argument of mxPath() to 'values'
408     - renamed 'name' argument of mxPath() to 'labels'
409     - renamed 'boundMin' argument of mxPath() to 'lbound'
410     - renamed 'boundMax' argument of mxPath() to 'ubound'
411     - eliminated 'ciLower' argument of mxPath()
412     - eliminated 'ciUpper' argument of mxPath()
413     - eliminated 'description' argument of mxPath()
414
415 * (dimnames) implemented dimnames(x) for MxMatrix objects
416     - implemented dimnames(x) <- value for MxMatrix objects
417     - implemented dimnames(x) for MxAlgebra objects
418     - implemented dimnames(x) <- value for MxAlgebra objects
419
420 * (mxMatrix) added 'dimnames' argument to mxMatrix()
421
422 * (mxData) renamed 'vector' argument of mxData() to 'means'