More verbose errors for mxPath()
[openmx:openmx.git] / R / MxPath.R
1 #
2 #   Copyright 2007-2009 The OpenMx Project
3 #
4 #   Licensed under the Apache License, Version 2.0 (the "License");
5 #   you may not use this file except in compliance with the License.
6 #   You may obtain a copy of the License at
7
8 #        http://www.apache.org/licenses/LICENSE-2.0
9
10 #   Unless required by applicable law or agreed to in writing, software
11 #   distributed under the License is distributed on an "AS IS" BASIS,
12 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 #   See the License for the specific language governing permissions and
14 #   limitations under the License.
15
16 # returns a list of paths
17 generatePath <- function(from, to, 
18                 all, arrows, values, free,
19                 labels, lbound, ubound) {
20                 if (single.na(to)) {
21                         to <- from
22                         loop <- TRUE
23                 } else {
24                         loop <- FALSE
25                 }
26                 from <- as.list(from)
27                 to <- as.list(to)
28                 if (all) {
29                         from <- rep(from, each=length(to))      
30                 }
31                 if(!is.null(labels)) { 
32                         lapply(labels, omxVerifyReference, 
33                                 paste("path from", omxQuotes(from), "to", omxQuotes(to)))
34                 }
35         pathCheckLengths(from, to, arrows, values, 
36             free, labels, lbound, ubound, loop)
37                 result <- suppressWarnings(mapply(generateSinglePath, from, to, 
38                 arrows, values, free,
39                 labels, lbound, ubound, SIMPLIFY = FALSE))
40                 return(result)
41 }
42
43 pathCheckLengths <- function(from, to, arrows, values, 
44         free, labels, lbound, ubound, loop) {
45     numPaths <- max(length(from), length(to))
46     pathCheckSingleLength(numPaths, length(arrows), "arrows", from, to, loop)
47     pathCheckSingleLength(numPaths, length(values), "values", from, to, loop)
48     pathCheckSingleLength(numPaths, length(free), "free/fixed designations", from, to, loop)
49     pathCheckSingleLength(numPaths, length(labels), "labels", from, to, loop)
50     pathCheckSingleLength(numPaths, length(lbound), "lbounds", from, to, loop)
51     pathCheckSingleLength(numPaths, length(ubound), "ubounds", from, to, loop)
52 }
53
54 pathCheckSingleLength <- function(numPaths, len, lenName, from, to, loop) {
55     if (numPaths < len) {
56         if (loop) { to <- NA }
57         stop(paste("mxPath() call will generate", 
58             numPaths, "paths but you have specified",
59             len, lenName, "with 'from' argument assigned to", omxQuotes(from),
60             "and 'to' argument assigned to", omxQuotes(to)), call. = FALSE)
61     }
62 }
63
64
65 generateSinglePath <- function(from, to, 
66                 arrows, values, free,
67                 labels, lbound, ubound) {
68         result <- list()
69         result[['from']] <- from
70         result[['to']] <- to
71         result[['arrows']] <- arrows[[1]]
72         result[['values']] <- values[[1]]       
73         result[['free']] <- free[[1]]
74         result[['labels']] <- labels[[1]]       
75         result[['lbound']] <- lbound[[1]]
76         result[['ubound']] <- ubound[[1]]
77         return(result)
78 }
79
80 omxIsPath <- function(value) {
81         return(is.list(value) && 
82                 !is.null(value[['from']]) &&
83                 !is.null(value[['to']]))
84 }
85
86 matrixToPaths <- function(mxMatrix, arrows = c(1,2)) {
87         values <- mxMatrix@values
88         select <- (values != 0)
89         if (length(select) > 0) {
90             rowFactors <- row(values, as.factor=TRUE)
91             colFactors <- col(values, as.factor=TRUE)   
92                 fromNames <- as.character(colFactors[select])
93                 toNames <- as.character(rowFactors[select])
94                 return(mxPath(from = fromNames, to = toNames, arrows = arrows))
95         } else {
96                 return(list())
97         }
98 }
99
100 pathCheckVector <- function(value, valname, type) {
101         if (!is.vector(value)) {
102                 stop(paste("The", omxQuotes(valname), 
103                         "argument to mxPath must be a",
104                         type, "vector."), call. = FALSE)
105         }
106 }
107
108 mxPath <- function(from, to = NA, all = FALSE, arrows = 1, free = TRUE,
109         values = NA, labels = NA, lbound = NA, ubound = NA) {
110         if (all != TRUE && all != FALSE) {
111                 stop("The 'all' argument to mxPath must be either true or false.", 
112                         call. = FALSE)
113         }
114         pathCheckVector(from, 'from', 'character')
115         pathCheckVector(to, 'to', 'character')
116         pathCheckVector(arrows, 'arrows', 'numeric')
117         pathCheckVector(free, 'free', 'logical')
118         pathCheckVector(labels, 'labels', 'character')
119         pathCheckVector(values, 'values', 'numeric')
120         pathCheckVector(lbound, 'lbound', 'numeric')
121         pathCheckVector(ubound, 'ubound', 'numeric')
122         from <- as.character(from)
123         to <- as.character(to)
124         arrows <- as.numeric(arrows)
125         free <- as.logical(free)
126         values <- as.numeric(values)
127         labels <- as.character(labels)
128         lbound <- as.numeric(lbound)
129         ubound <- as.numeric(ubound)
130         if (single.na(values)) values <- NULL
131         if (single.na(labels)) labels <- NULL
132         if (single.na(lbound)) lbound <- NULL
133         if (single.na(ubound)) ubound <- NULL
134         generatePath(from, to, all, arrows, 
135                 values, free, labels, 
136                 lbound, ubound)
137 }