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