Documentation

Posted on
Picture of user. tbates Joined: 07/31/2009

error in 2.1.1 multiple regression model?

Forums
Hi
There are two paths called βyz in the un-titled figure currently on page 26

Seems that one should be βx and the other βz (the one that is currently βy should be β0)?

Similar issue in the simple regression figure (unlabeled, but currently on page 22)

Somewhere around here in the documentation some explanation of the triangle should be given too: I think users will be wondering:

If it's a mean, how can it be connected to all three variables?

Posted on
Picture of user. tbates Joined: 07/31/2009

Consistency in parameter labels

Forums
The regression example (2.1.1 Simple Regression)

states y = β0 + β 1 ∗ x + ϵ

Then in the text below the parameters are called " β0 , β1 , σ2, ϵ , and the mean and variance of x".

And then in the diagram we see σ2x2y, βy, βyz and μx.

Posted on
No user picture. Paras Joined: 07/31/2009

Documentation tools setup (Sphinx, Sweave etc.)

Forums
Is there a description of how to setup documentation tools??

Color coding looks good. Is there any way we could add openMX key words (function and parameters) to the list of recognized key words. These could be displayed in a different color.

Posted on
Picture of user. Steve Joined: 07/30/2009

Tutorials start too fast

Forums
As we begin to get comments, I think we may be surprised at how rapidly our tutorials tend to move relative to the general public of SEM'ers. We run the risk of turning people off before they even begin.

Posted on
Picture of user. Jeff Joined: 07/31/2009

large function call confusion, commas, and semicolons

Forums
We spoke about this before, but, as Bill pointed out recently, having blocks of code that cannot be evaluated (and that appears to be ending in commas) is going to be a source of confusion for users. Unless we place those pieces of code in the context of a large function call--by showing that large function call as one unit before the other pieces (and possibly referring to line numbers, which can be turned on)--we should probably just make use of variables in R.

We also have some irregular usage of semicolons in the documentation that needs addressed.

Posted on
Picture of user. tbates Joined: 07/31/2009

Where should example data live?

Forums
Hi all,
Currently, the example on the front page doesn't work out of the box, because.

demoData = read.csv("demoOneFactor.csv", header=TRUE)
# cannot open file 'demoOneFactor.csv': No such file or directory

Just because it's so obvious on the home page, I think a lot of people will copy and paste it in, so it would be nice if it ran...

I can't see a datafile in the package called "demoOneFactor.csv"

Using the ability of R to access the web, we could do:
read.csv("http://openmx.psyc.virginia.edu/data/demoOneFactor.csv", header = TRUE)

Posted on
Picture of user. Steve Joined: 07/30/2009

Welcome to the Documentation forum

Forums
This is a place to alert the developer team to typos or errors in the documentation, to make suggestions about how to improve the documentation, or to discuss the demo scripts that go along with the documentation.

We expect this forum to be used by the beta testers as well as the development team.