File: mxPenaltyZap.Rd

package info (click to toggle)
r-cran-openmx 2.21.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 14,412 kB
  • sloc: cpp: 36,577; ansic: 13,811; fortran: 2,001; sh: 1,440; python: 350; perl: 21; makefile: 5
file content (23 lines) | stat: -rw-r--r-- 837 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/MxPenalty.R
\name{mxPenaltyZap}
\alias{mxPenaltyZap}
\title{mxPenaltyZap}
\usage{
mxPenaltyZap(model, silent = FALSE)
}
\arguments{
\item{model}{an \link{MxModel}}

\item{silent}{whether to suppress diagnostic output}
}
\description{
Fix any free parameters within \code{epsilon} of zero to
zero. These parameters are no longer estimated. Remove all
\link[=MxPenalty-class]{MxPenalty} objects from the model.  This is envisioned to be
used after using \link{mxPenaltySearch} to locate the best penalty
hyperparameters and apply penalties to model estimation. While
penalties can simplify a model, they also bias parameters toward
zero. By re-estimating the model after using \code{mxPenaltyZap},
parameters that remain free are likely to exhibit less bias.
}