Added R help pages for omxCheck() unit testing functions
[openmx:openmx.git] / man / omxCheckSetEquals.Rd
1 \name{omxCheckSetEquals}
2 \alias{omxCheckSetEquals}
3
4 \title{Set Equality Testing Function}
5
6 \description{
7    This function tests whether two vectors contain the same elements.
8 }
9
10 \usage{
11 omxCheckSetEquals(a, b)
12 }
13
14 \arguments{
15    \item{a}{The first vector to compare.}
16    \item{b}{The second vector to compare.}
17 }
18
19 \details{
20 Performs the \sQuote{setequal} function on the two arguments. If the two arguments do not contain the same elements, then an error will be thrown. If \sQuote{a} and \sQuote{b} contain the same elements, by default the function will print a statement informing the user the test has passed.  To turn off these print statements use \code{options("mxPrintUnitTests" = FALSE)}.
21 }
22
23 \references{
24 The OpenMx User's guide can be found at http://openmx.psyc.virginia.edu/documentation.
25 }
26
27 \seealso{\itemize{
28 \item{\code{\link{omxCheckCloseEnough}}}{for approximate equality testing within an epsilon.}
29 \item{\code{\link{omxCheckWithinPercentError}}}{for approximate equality testing within a percentage.}
30 \item{\code{\link{omxCheckEquals}}}{for exact equality testing.}
31 \item{\code{\link{omxCheckTrue}}}{for boolean equality testing.}
32 }}
33
34 \examples{
35
36 omxCheckSetEquals(c(1, 1, 2, 2, 3), c(3, 2, 1))
37
38 omxCheckSetEquals(matrix(1, 1, 1), matrix(1, 3, 3))
39
40 # Throws an error
41 try(omxCheckSetEquals(c(1, 2, 3, 4), c(2, 1, 3)))
42
43 }