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