blimp.print {misty} | R Documentation |
Print Blimp Output
Description
This function prints the result sections of a Blimp output file (.blimp-out
)
on the R console. By default, the function prints selected result sections,
i.e., Algorithmic Options Specified
, Data Information
,
Model Information
, Warning Messages
, Outcome Model Estimates
,
and Generated Parameters
.
Usage
blimp.print(x,
result = c("all", "default", "algo.options", "data.info",
"model.info", "warn.mess", "error.mess", "out.model", "gen.param"),
exclude = NULL, color = c("none", "blue", "green"),
style = c("bold", "regular"), not.result = TRUE,
write = NULL, append = TRUE, check = TRUE, output = TRUE)
Arguments
x |
a character string indicating the name of the Blimp output
file with or without the file extension |
result |
a character vector specifying Blimp result sections included in the output (see 'Details'). |
exclude |
a character vector specifying Blimp input command or result sections excluded from the output (see 'Details'). |
color |
a character vector with two elements indicating the colors
used for the main headers (e.g., |
style |
a character vector with two elements indicating the style
used for headers (e.g., |
not.result |
logical: if |
write |
a character string naming a file for writing the output into
a text file with file extension |
append |
logical: if |
check |
logical: if |
output |
logical: if |
Details
- Result Sections
Following result sections can be selected by using the
result
argument or excluded by using theexclude
argument:"algo.options"
for theALGORITHMIC OPTIONS SPECIFIED
section"simdat.summary"
for theSIMULATED DATA SUMMARIES
section"order.simdat"
for theVARIABLE ORDER IN SIMULATED DATA
section"burnin.psr"
for theBURN-IN POTENTIAL SCALE REDUCTION (PSR) OUTPUT
section"mh.accept"
for theMETROPOLIS-HASTINGS ACCEPTANCE RATES
section"data.info"
for theDATA INFORMATION
section"var.imp"
for theVARIABLES IN IMPUTATION MODEL
section"model.info"
for theMODEL INFORMATION
section"param.label"
for thePARAMETER LABELS
section"warn.mess"
for theWARNING MESSAGES
section"fit"
for theMODEL FIT
section"cor.resid"
for theCORRELATIONS AMONG RESIDUALS
section"out.model"
for theOUTCOME MODEL ESTIMATES
section"pred.model"
for thePREDICTOR MODEL ESTIMATES
section"gen.param"
for theGENERATED PARAMETERS
section"order.impdat"
for theVARIABLE ORDER IN IMPUTED DATA
section
Note that all result sections are requested by specifying
result = "all"
. Theresult
argument is also used to select one (e.g.,result = "algo.options"
) or more than one result sections (e.g.,result = c("algo.options", "fit")
), or to request result sections in addition to the default setting (e.g.,result = c("default", "fit")
). Theexclude
argument is used to exclude result sections from the output (e.g.,exclude = "algo.options"
).
Value
Returns an object of class misty.object
, which is a list with following
entries:
call |
function call |
type |
type of analysis |
x |
character string or misty object |
args |
specification of function arguments |
print |
print objects |
notprint |
character vectors indicating the result sections not requested |
result |
list with Blimp version ( |
Author(s)
Takuya Yanagida
References
Keller, B. T., & Enders, C. K. (2023). Blimp user’s guide (Version 3). Retrieved from www.appliedmissingdata.com/blimp
See Also
blimp
, blimp.update
, blimp.run
, blimp.plot
, blimp.bayes
Examples
## Not run:
#----------------------------------------------------------------------------
# Blimp Example 4.3: Linear Regression
# Example 1a: Default setting
blimp.print("Ex4.3.blimp-out")
# Example 1c: Print OUTCOME MODEL ESTIMATES only
blimp.print("Ex4.3.blimp-out", result = "out.model")
# Example 1d: Print MODEL FIT in addition to the default setting
blimp.print("Ex4.3.blimp-out", result = c("default", "fit"))
# Example 1e: Exclude DATA INFORMATION section
blimp.print("Ex4.3.blimp-out", exclude = "data.info")
# Example 1f: Print all result sections, but exclude MODEL FIT section
blimp.print("Ex4.3.blimp-out", result = "all", exclude = "fit")
# Example 1g: Print result section in a different order
blimp.print("Ex4.3.blimp-out", result = c("model.info", "fit", "algo.options"))
#----------------------------------------------------------------------------
# misty.object of type 'blimp.print'
# Example 2
# Create misty.object
object <- blimp.print("Ex4.3.blimp-out", output = FALSE)
# Print misty.object
blimp.print(object)
#----------------------------------------------------------------------------
# Write Results
# Example 3: Write Results into a text file
blimp.print("Ex4.3.blimp-out", write = "Output_4-3.txt")
## End(Not run)