XPSConstrain: XPSConstrain function to set fit constraints

View source: R/XPSConstrain.r

XPSConstrainR Documentation

XPSConstrain function to set fit constraints

Description

XPSConstrain function allows a direct setting of the constraints needed for the best fit of a Core-Line. Generally constraints are set more easily by using the /codeXPSConstraintsGUI() function, a simple and powerful GUI.

Usage

XPSConstrain(
  Object,
  ncomponent = NA,
  action = c("show", "link", "fix", "set", "remove"),
  variable = NULL,
  parameter = NULL,
  value = NA,
  expr
)

Arguments

Object

XPSSample

ncomponent

the fit component index

action

link, fix, set, remove the constraint to apply or remove

variable

h, mu, sigma, etc. the fit parameter to constrain

parameter

one of the values start, min, max

value

the value to set

expr

the constraint expression

Examples

## Not run: 
 XPSConstrain(XPSCoreline[[3]], ncomponent=2, action="link", variable="mu", expr="mu1+1.5")
 XPSConstrain(XPSCoreline[[2]], ncomponent=3, action="link", variable="sigma", expr="sigma1")

## End(Not run)

GSperanza/RxpsG_2.3-1 documentation built on Feb. 11, 2024, 5:09 p.m.