1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/MxCompute.R
\name{mxComputeCheckpoint}
\alias{mxComputeCheckpoint}
\alias{MxComputeCheckpoint-class}
\title{Log parameters and state to disk or memory}
\usage{
mxComputeCheckpoint(
what = NULL,
...,
path = NULL,
append = FALSE,
header = TRUE,
toReturn = FALSE,
parameters = TRUE,
loopIndices = TRUE,
fit = TRUE,
counters = TRUE,
status = TRUE,
standardErrors = FALSE,
gradient = FALSE,
vcov = FALSE,
vcovFilter = c(),
sampleSize = FALSE,
vcovWLS = FALSE,
useVcovFilter = FALSE
)
}
\arguments{
\item{what}{a character vector of algebra names to include in each checkpoint}
\item{...}{Not used. Forces remaining arguments to be specified by name}
\item{path}{a character vector of where to write the checkpoint file}
\item{append}{if FALSE, truncates the checkpoint file upon open. If TRUE, existing data is preserved and checkpoints are appended.}
\item{header}{whether to write the header that describes the content of each column}
\item{toReturn}{logical. Whether to store the checkpoint in memory and return it after the model is run}
\item{parameters}{logical. Whether to include the parameter vector}
\item{loopIndices}{logical. Whether to include the loop indices}
\item{fit}{logical. Whether to include the fit value}
\item{counters}{logical. Whether to include counters (number of evaluations and iterations)}
\item{status}{logical. Whether to include the status code}
\item{standardErrors}{logical. Whether to include the standard errors}
\item{gradient}{logical. Whether to include the gradients}
\item{vcov}{logical. Whether to include the vcov in half-vectorized order}
\item{vcovFilter}{character vector. Vector of parameters indicating
which parameter covariances to include. Only the variance is
included for those parameters not mentioned.}
\item{sampleSize}{logical. Whether to include the sample size of the mxData. \lifecycle{experimental}}
\item{vcovWLS}{logical. Whether to include the vcov from WLS residualizing regressions in half-vectorized order}
\item{useVcovFilter}{logical. Whether to use the vcovFilter (TRUE) or include all entries (FALSE)}
}
\description{
Captures the current state of the backend. When \code{path} is set, the
state is written to disk in a single row. When \code{toReturn} is set,
the state is recorded in memory and returned after \code{mxRun}.
}
\examples{
library(OpenMx)
m1 <- mxModel(
"poly22", # Eqn 22 from Tsallis & Stariolo (1996)
mxMatrix(type='Full', values=runif(4, min=-1e6, max=1e6),
ncol=1, nrow=4, free=TRUE, name='x'),
mxAlgebra(sum((x*x-8)^2) + 5*sum(x) + 57.3276, name="fit"),
mxFitFunctionAlgebra('fit'))
plan <- mxComputeLoop(list(
mxComputeSetOriginalStarts(),
mxComputeSimAnnealing(method="tsallis1996",
control=list(tempEnd=1)),
mxComputeCheckpoint(path = "result.log")),
i=1:4)
m1 <- mxRun(mxModel(m1, plan)) # see the file 'result.log'
}
\seealso{
\code{\link{mxComputeLoadData}}, \code{\link{mxComputeLoadMatrix}},
\code{\link{mxComputeLoadContext}}, \code{\link{mxComputeLoop}}
Other model state:
\code{\link{mxRestore}()},
\code{\link{mxSave}()}
}
\concept{model state}
|
