Updated copyright to 2013 for R/ demo/ models/passing and src/ folders, and also...
[openmx:openmx.git] / R / MxMLObjective.R
1 #
2 #   Copyright 2007-2013 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 mxMLObjective <- function(covariance, means = NA, dimnames = NA, thresholds = NA) {
17         if (missing(covariance) || typeof(covariance) != "character") {
18                 stop("Covariance argument is not a string (the name of the expected covariance matrix)")
19         }
20         if (!(single.na(means) || typeof(means) == "character")) {
21                 stop("Means argument is not a string (the name of the expected means matrix)")
22         }
23         if (is.na(means)) means <- as.integer(NA)
24         if (single.na(thresholds)) thresholds <- as.character(NA)
25         if (single.na(dimnames)) dimnames <- as.character(NA)
26         if (!is.vector(dimnames) || typeof(dimnames) != 'character') {
27                 stop("Dimnames argument is not a character vector")
28         }
29         if (length(thresholds) != 1) {
30                 stop("Thresholds argument must be a single matrix or algebra name")
31         }
32         if (length(dimnames) == 0) {
33                 stop("Dimnames argument cannot be an empty vector")
34         }
35         if (length(dimnames) > 1 && any(is.na(dimnames))) {
36                 stop("NA values are not allowed for dimnames vector")
37         }
38         expectation <- mxExpectationNormal(covariance, means, dimnames, thresholds)
39         fitfunction <- mxFitFunctionML(FALSE)
40         msg <- paste("Objective functions have been deprecated.",
41                 "Please use mxExpectationNormal() and mxFitFunctionML() instead.")
42         warning(msg)
43         return(list(expectation, fitfunction))
44 }