|
ChoiceList
|
Batch language command
|
|
Used to present the user with a list of choices, and guides the user through the process of selecting one (or more) of them. If the user made a valid selection, then the string value of the selection is stored in the variable SELECTION_STRINGS.
|
Syntax
|
ChoiceList (result,"Title",selection length,skip flag,"option 1 name","option 1 description","option 2 name","option 2 description",...,"option N name","option N description"); or ChoiceList (result,"Title",selection length,skip flag,object)
|
Notes
|
'result' holds the choice of the user. If the user selected one option only (triggered by, selection length flag) 'result' holds either -1 if the selection was cancelled, or the index of the selected option starting at 0. If more than option were selected 'result' is a vector with indices of selections. If the [0] element of 'result' is -1 then the selection process was cancelled. "Title" is the title of the selection list 'selection length' indicates how many choices the user must make. 0 means that the user is allowed ti make an arbitrary (1 or more) number of choices 'skip flag' is either SKIP_NONE, so that all selections are available to the user or a vector of selection indices to skip The list of selections afterwards is simply a collection of available choices. You may place an object identifier nstead of the explicit list of selections. It could be: 1). A dataset (the selections are taxa names) 2). A datasetfilter (the selections are taxa names). 3). If this argument is the literal "LikelihoodFunction" then the list of currently defines likelihood functions will be generated. 4). If this argument is the literal LAST_MODEL_PARAMETER_LIST, then the list of parameters of the model which was last declared will be generated. This list will later include other objects.
|
Examples
|
|
Last modified: 6/7/2001 |
|
|