Added more documentation. Switched the order of arguments
[openmx:openmx.git] / man / mxConstraint.Rd
1 \name{mxConstraint}
2 \alias{mxConstraint}
3
4 \title{Create MxConstraint Object}
5
6 \description{
7    This function creates a new \link{MxConstraint} object.
8 }
9
10 \arguments{
11    \item{alg1}{A character string indicating the 
12                 name of an \link{MxAlgebra} or \link{MxMatrix} object.}
13    \item{relation}{A character string indicating the relation between
14                 alg1 and alg2. Must be either "<", "=", or ">".}
15    \item{alg2}{A character string indicating the
16                 name of an \link{MxAlgebra} or \link{MxMatrix} object.}   
17    \item{name}{A character string indicating the
18                 name of this object. Optional.}
19 }
20
21 \value{
22         Returns a new \link{MxConstraint} object.
23 }
24
25 \examples{
26
27    #Create a constraint between MxMatrices 'A' and 'B'
28    constraint <- mxConstraint('A', '=', 'B', name = 'constraint')
29
30 }