File: imxAutoOptionValue.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 (24 lines) | stat: -rw-r--r-- 865 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
24
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/MxOptions.R
\name{imxAutoOptionValue}
\alias{imxAutoOptionValue}
\title{imxAutoOptionValue}
\usage{
imxAutoOptionValue(optionName, optionList = options()$mxOption)
}
\arguments{
\item{optionName}{Character string naming the \link{mxOption} for which a numeric or integer value is wanted.}

\item{optionList}{List of options; defaults to list of global \link{mxOption}s.
imxAutoOptionValue}
}
\description{
Convert "Auto" placeholders in global mxOptions to actual default values.
}
\details{
This is an internal function exported for documentation purposes.
Its primary purpose is to convert the on-load value of "Auto"to
valid values for \link{mxOption}s \sQuote{Gradient step size},
\sQuote{Gradient iterations}, and
\sQuote{Function precision}--respectively, 1.0e-7, 1L, and 1e-14.
}