From 5e4052848f88359618324045ef939f46c35666d4 Mon Sep 17 00:00:00 2001 From: Tim Bates Date: Sat, 1 Feb 2025 03:58:55 +0000 Subject: [PATCH] rd --- NAMESPACE | 1 + man/umx.Rd | 1 + man/umx_get_alphas.Rd | 46 +++++++++++++++++++++++++++++ man/umx_get_checkpoint.Rd | 1 + man/umx_get_options.Rd | 1 + man/umx_set_auto_plot.Rd | 1 + man/umx_set_auto_run.Rd | 1 + man/umx_set_checkpoint.Rd | 1 + man/umx_set_condensed_slots.Rd | 1 + man/umx_set_cores.Rd | 1 + man/umx_set_data_variance_check.Rd | 1 + man/umx_set_dollar_symbol.Rd | 1 + man/umx_set_optimization_options.Rd | 1 + man/umx_set_optimizer.Rd | 1 + man/umx_set_plot_file_suffix.Rd | 1 + man/umx_set_plot_format.Rd | 1 + man/umx_set_plot_use_hrbrthemes.Rd | 1 + man/umx_set_separator.Rd | 1 + man/umx_set_silent.Rd | 1 + man/umx_set_table_format.Rd | 1 + 20 files changed, 65 insertions(+) create mode 100644 man/umx_get_alphas.Rd diff --git a/NAMESPACE b/NAMESPACE index c0cc1ccf..d38e4ca6 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -204,6 +204,7 @@ export(umx_factor) export(umx_file_load_pseudo) export(umx_find_object) export(umx_fun_mean_sd) +export(umx_get_alphas) export(umx_get_bracket_addresses) export(umx_get_checkpoint) export(umx_get_options) diff --git a/man/umx.Rd b/man/umx.Rd index d1589892..37fbae95 100644 --- a/man/umx.Rd +++ b/man/umx.Rd @@ -198,6 +198,7 @@ Other Teaching and testing Functions: \code{\link{tmx_is.identified}()} Other Get and set: +\code{\link{umx_get_alphas}()}, \code{\link{umx_get_checkpoint}()}, \code{\link{umx_get_options}()}, \code{\link{umx_set_auto_plot}()}, diff --git a/man/umx_get_alphas.Rd b/man/umx_get_alphas.Rd new file mode 100644 index 00000000..2c592eaa --- /dev/null +++ b/man/umx_get_alphas.Rd @@ -0,0 +1,46 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/misc_and_utility.R +\name{umx_get_alphas} +\alias{umx_get_alphas} +\title{Get the alpha text} +\usage{ +umx_get_alphas(umx_alpha_text = NULL, silent = FALSE) +} +\arguments{ +\item{umx_alpha_text}{(if empty, returns the current value)} + +\item{silent}{If TRUE, no message will be printed.} +} +\value{ +- Current umx_alpha_text +} +\description{ +Get umx_alpha_text. Optionally SET it blank +} +\examples{ +library(umx) +umx_get_alphas() # show current state +umx_get_alphas("") # blank it +} +\seealso{ +Other Get and set: +\code{\link{umx}}, +\code{\link{umx_get_checkpoint}()}, +\code{\link{umx_get_options}()}, +\code{\link{umx_set_auto_plot}()}, +\code{\link{umx_set_auto_run}()}, +\code{\link{umx_set_checkpoint}()}, +\code{\link{umx_set_condensed_slots}()}, +\code{\link{umx_set_cores}()}, +\code{\link{umx_set_data_variance_check}()}, +\code{\link{umx_set_dollar_symbol}()}, +\code{\link{umx_set_optimization_options}()}, +\code{\link{umx_set_optimizer}()}, +\code{\link{umx_set_plot_file_suffix}()}, +\code{\link{umx_set_plot_format}()}, +\code{\link{umx_set_plot_use_hrbrthemes}()}, +\code{\link{umx_set_separator}()}, +\code{\link{umx_set_silent}()}, +\code{\link{umx_set_table_format}()} +} +\concept{Get and set} diff --git a/man/umx_get_checkpoint.Rd b/man/umx_get_checkpoint.Rd index 02a2a9cd..dca6b1f8 100644 --- a/man/umx_get_checkpoint.Rd +++ b/man/umx_get_checkpoint.Rd @@ -38,6 +38,7 @@ umx_get_checkpoint(model = m1) \seealso{ Other Get and set: \code{\link{umx}}, +\code{\link{umx_get_alphas}()}, \code{\link{umx_get_options}()}, \code{\link{umx_set_auto_plot}()}, \code{\link{umx_set_auto_run}()}, diff --git a/man/umx_get_options.Rd b/man/umx_get_options.Rd index 63dbcbde..8d868abb 100644 --- a/man/umx_get_options.Rd +++ b/man/umx_get_options.Rd @@ -18,6 +18,7 @@ umx_get_options() \seealso{ Other Get and set: \code{\link{umx}}, +\code{\link{umx_get_alphas}()}, \code{\link{umx_get_checkpoint}()}, \code{\link{umx_set_auto_plot}()}, \code{\link{umx_set_auto_run}()}, diff --git a/man/umx_set_auto_plot.Rd b/man/umx_set_auto_plot.Rd index 04690fc0..764a4cdb 100644 --- a/man/umx_set_auto_plot.Rd +++ b/man/umx_set_auto_plot.Rd @@ -40,6 +40,7 @@ umx_set_auto_plot(old) # reinstate \seealso{ Other Get and set: \code{\link{umx}}, +\code{\link{umx_get_alphas}()}, \code{\link{umx_get_checkpoint}()}, \code{\link{umx_get_options}()}, \code{\link{umx_set_auto_run}()}, diff --git a/man/umx_set_auto_run.Rd b/man/umx_set_auto_run.Rd index a3713464..cd3606e5 100644 --- a/man/umx_set_auto_run.Rd +++ b/man/umx_set_auto_run.Rd @@ -29,6 +29,7 @@ umx_set_auto_run(old) # reinstate \seealso{ Other Get and set: \code{\link{umx}}, +\code{\link{umx_get_alphas}()}, \code{\link{umx_get_checkpoint}()}, \code{\link{umx_get_options}()}, \code{\link{umx_set_auto_plot}()}, diff --git a/man/umx_set_checkpoint.Rd b/man/umx_set_checkpoint.Rd index 4cd5a287..eab9e0f7 100644 --- a/man/umx_set_checkpoint.Rd +++ b/man/umx_set_checkpoint.Rd @@ -61,6 +61,7 @@ umx_checkpoint(0) \seealso{ Other Get and set: \code{\link{umx}}, +\code{\link{umx_get_alphas}()}, \code{\link{umx_get_checkpoint}()}, \code{\link{umx_get_options}()}, \code{\link{umx_set_auto_plot}()}, diff --git a/man/umx_set_condensed_slots.Rd b/man/umx_set_condensed_slots.Rd index b9b3f55c..e24516da 100644 --- a/man/umx_set_condensed_slots.Rd +++ b/man/umx_set_condensed_slots.Rd @@ -34,6 +34,7 @@ umx_set_condensed_slots(old) # set back \seealso{ Other Get and set: \code{\link{umx}}, +\code{\link{umx_get_alphas}()}, \code{\link{umx_get_checkpoint}()}, \code{\link{umx_get_options}()}, \code{\link{umx_set_auto_plot}()}, diff --git a/man/umx_set_cores.Rd b/man/umx_set_cores.Rd index 5672c41e..d5507062 100644 --- a/man/umx_set_cores.Rd +++ b/man/umx_set_cores.Rd @@ -46,6 +46,7 @@ umx_set_cores(oldCores) # reinstate old global value \seealso{ Other Get and set: \code{\link{umx}}, +\code{\link{umx_get_alphas}()}, \code{\link{umx_get_checkpoint}()}, \code{\link{umx_get_options}()}, \code{\link{umx_set_auto_plot}()}, diff --git a/man/umx_set_data_variance_check.Rd b/man/umx_set_data_variance_check.Rd index 3550734f..0ad566e4 100644 --- a/man/umx_set_data_variance_check.Rd +++ b/man/umx_set_data_variance_check.Rd @@ -32,6 +32,7 @@ xmu_check_variance which uses these to check sanity in the variances of a data f Other Get and set: \code{\link{umx}}, +\code{\link{umx_get_alphas}()}, \code{\link{umx_get_checkpoint}()}, \code{\link{umx_get_options}()}, \code{\link{umx_set_auto_plot}()}, diff --git a/man/umx_set_dollar_symbol.Rd b/man/umx_set_dollar_symbol.Rd index ad3852ca..44404d38 100644 --- a/man/umx_set_dollar_symbol.Rd +++ b/man/umx_set_dollar_symbol.Rd @@ -27,6 +27,7 @@ umx_set_dollar_symbol(old) # reinstate \seealso{ Other Get and set: \code{\link{umx}}, +\code{\link{umx_get_alphas}()}, \code{\link{umx_get_checkpoint}()}, \code{\link{umx_get_options}()}, \code{\link{umx_set_auto_plot}()}, diff --git a/man/umx_set_optimization_options.Rd b/man/umx_set_optimization_options.Rd index bea1270e..1a1a32f5 100644 --- a/man/umx_set_optimization_options.Rd +++ b/man/umx_set_optimization_options.Rd @@ -49,6 +49,7 @@ umx_set_optimization_options("Parallel diagnostics", value = "Yes") \seealso{ Other Get and set: \code{\link{umx}}, +\code{\link{umx_get_alphas}()}, \code{\link{umx_get_checkpoint}()}, \code{\link{umx_get_options}()}, \code{\link{umx_set_auto_plot}()}, diff --git a/man/umx_set_optimizer.Rd b/man/umx_set_optimizer.Rd index de7e6622..8dc88fff 100644 --- a/man/umx_set_optimizer.Rd +++ b/man/umx_set_optimizer.Rd @@ -37,6 +37,7 @@ umx_set_optimizer(old) # set back \seealso{ Other Get and set: \code{\link{umx}}, +\code{\link{umx_get_alphas}()}, \code{\link{umx_get_checkpoint}()}, \code{\link{umx_get_options}()}, \code{\link{umx_set_auto_plot}()}, diff --git a/man/umx_set_plot_file_suffix.Rd b/man/umx_set_plot_file_suffix.Rd index 1b361cb1..171a90d9 100644 --- a/man/umx_set_plot_file_suffix.Rd +++ b/man/umx_set_plot_file_suffix.Rd @@ -36,6 +36,7 @@ umx_set_plot_file_suffix(old) # reinstate \seealso{ Other Get and set: \code{\link{umx}}, +\code{\link{umx_get_alphas}()}, \code{\link{umx_get_checkpoint}()}, \code{\link{umx_get_options}()}, \code{\link{umx_set_auto_plot}()}, diff --git a/man/umx_set_plot_format.Rd b/man/umx_set_plot_format.Rd index b928cd09..460a2be9 100644 --- a/man/umx_set_plot_format.Rd +++ b/man/umx_set_plot_format.Rd @@ -38,6 +38,7 @@ umx_set_plot_format(old) # reinstate \seealso{ Other Get and set: \code{\link{umx}}, +\code{\link{umx_get_alphas}()}, \code{\link{umx_get_checkpoint}()}, \code{\link{umx_get_options}()}, \code{\link{umx_set_auto_plot}()}, diff --git a/man/umx_set_plot_use_hrbrthemes.Rd b/man/umx_set_plot_use_hrbrthemes.Rd index b9d0a1fc..0bb93bcd 100644 --- a/man/umx_set_plot_use_hrbrthemes.Rd +++ b/man/umx_set_plot_use_hrbrthemes.Rd @@ -29,6 +29,7 @@ umx_set_plot_use_hrbrthemes(old) # reinstate \seealso{ Other Get and set: \code{\link{umx}}, +\code{\link{umx_get_alphas}()}, \code{\link{umx_get_checkpoint}()}, \code{\link{umx_get_options}()}, \code{\link{umx_set_auto_plot}()}, diff --git a/man/umx_set_separator.Rd b/man/umx_set_separator.Rd index e4ff25fb..f2a5bce6 100644 --- a/man/umx_set_separator.Rd +++ b/man/umx_set_separator.Rd @@ -28,6 +28,7 @@ umx_set_separator(old) # reinstate \seealso{ Other Get and set: \code{\link{umx}}, +\code{\link{umx_get_alphas}()}, \code{\link{umx_get_checkpoint}()}, \code{\link{umx_get_options}()}, \code{\link{umx_set_auto_plot}()}, diff --git a/man/umx_set_silent.Rd b/man/umx_set_silent.Rd index e819ab8a..8ed9837c 100644 --- a/man/umx_set_silent.Rd +++ b/man/umx_set_silent.Rd @@ -42,6 +42,7 @@ umx_set_silent() # print existing value \seealso{ Other Get and set: \code{\link{umx}}, +\code{\link{umx_get_alphas}()}, \code{\link{umx_get_checkpoint}()}, \code{\link{umx_get_options}()}, \code{\link{umx_set_auto_plot}()}, diff --git a/man/umx_set_table_format.Rd b/man/umx_set_table_format.Rd index fc488b99..28870c50 100644 --- a/man/umx_set_table_format.Rd +++ b/man/umx_set_table_format.Rd @@ -38,6 +38,7 @@ umx_set_table_format(old) # reinstate \seealso{ Other Get and set: \code{\link{umx}}, +\code{\link{umx_get_alphas}()}, \code{\link{umx_get_checkpoint}()}, \code{\link{umx_get_options}()}, \code{\link{umx_set_auto_plot}()},