Automation Reference - JMP

Application Object Reference for Automating JMP
Platform Methods
Launch() As Object
Launches the fit using all of the previously supplied information. Depending on the type of personality that was
selected, another Fit object will be returned that allows for further manipulation of the post-launch output. The
objects that can be returned are FitLeastSquares, FitStepwise, FitNominal, FitOrdinal, FitLogVariance,
FitProportional, and FitParametricSurvival. There is no object for the Manova fitting personality, due to
the highly interactive nature of its output.
LaunchAddCrossEffect() As Boolean
Creates a crossed model effect, using the columns specified in calls to LaunchAddToEffectList(Name As
String) As Boolean.
LaunchAddMacroEffect(fitModelMacroEffectConstants macroType) As Boolean
Adds a macro effect type, using the columns previously specified through LaunchAddToEffectList(Name As
String) As Boolean, the macro degree specified using LaunchSpecifyMacroDegree, and the type of macro
effect passed in as the macroType parameter. The macro type is one of the fitModelMacroEffectConstants. If a
macro degree has not been previously specified, degree 2 is used.
LaunchAddNestEffect() As Boolean
Enables the column that has been added using LaunchAddToEffectList(Name As String) As Boolean to be
used as a nesting effect within the effect that has been selected using LaunchSelectEffect(EffectNumber As
Integer, OnOffFlag As Boolean) As Boolean.
For example, suppose the column ID (the subject ID within each treatment) is added as a simple X Effect
(LaunchAddToEffectList(Name As String) As Boolean followed by LaunchAddXEffect() As Boolean). Next,
the column Dose is added using LaunchAddToEffectList(Name As String) As Boolean. Finally,
LaunchAddNestEffect() As Boolean is called and it creates the effect ID[Dose].
LaunchAddToEffectList(Name As String) As Boolean
Adds the column specified by Name to the effects columns list. This is the list of columns used when creating
Model Effects using the LaunchAddXEffect, LaunchAddNestEffect, LaunchAddCrossEffect, and
LaunchAddMacroEffect methods. This list does not contain the Effects created by these methods.
LaunchAddXEffect() As Boolean
Creates a simple model effect. This is the same as using the Add button in the Fit Model launcher dialog. The
columns currently in the effect column list are used. These must have been specified using
LaunchAddToEffectList(Name As String) As Boolean.
LaunchAddXEffectWithTransform(transform as fitModelTransforms)
Add a transformed effect. Examples are Exponential and Square. The name of the column to use for the effect
must have been added previously using LaunchAddToEffectList(Name As String) As Boolean.
LaunchAddYWithTransform(ColumnName As String, transform as fitModelTransforms) As Boolean
Add a Y variable to the analysis, supplying a transform like Log or Sqrt. Returns True for success, False for
failure.
Page 93