CLUSTER# returns a document or TeLiTab set with clustered data based on a series of solutions

Syntax

1. CLUSTER#(ObjName$)
2. CLUSTER#(0, ParList$, CellDelim$, ColArr$, IntSortCol%, IntAllowDoubles%)
3. CLUSTER#(1, SearchPar or SearchPar$, CaseNos$, [InpVar])

Arguments 

Method 1

• ObjName$ (a StrExp) is the name of an object and returns a TeLiTab#;

Method 2

• 0 returns a document (a large text without a particular meaning to Quaestor);
• ParList$ (a StrExp) is the list of parameters to be clustered in a document surrounded by # and can be delimited by comma's or spaces. It is also allowed to use # as delimiter but the parameter list should at least be started and closed by #;
• CellDelim$ (a StrExp) is a delimiter between clustered values of the parameters provided in ParList$. If "NullString" is provided, the values (per list and per solution in the cluster) are delimited by CrLf, so one value/set of values per line. If ParList$ contains more than one parameter, CellDelim$ is used as delimiter in the list per solution and between the values of each slotion, CrLf is used as delimiter for a presentation of a series of values.;
• ColArr$ (a StrExp) is "NullString" and for future extension of format commands in column data;
• IntSortCol (a NumExp) is an integer column number used to sort the table if ParList$ contains more than one parameter;
• IntAllowDoubles (a NumExp) is an integer number (0 or 1) to indicate whether double values are allowed in a clustered data set, only applicable to a ParList$ with a single parameter;

Method 3

• 1 returns a TeLiTab#
• SearchPar or SearchPar$ (a StrExp) is either a parameter or "parameter" as string. Please note that using a search parameter without quotes, requires te availability of a DETERMINED value for this parameter in the current solution.
• CaseNos$ (a StrExp) is a list of cases in the solutions to be retrieved. Use "0" or "NullString" if all available cases should be selected. If you want to have a particular set of cases of a solution, a list of cases should be provided, e.g. "3,4,5,6".
• [InpVar] (a StrExp) is an optional series of parameters to be included in the TeLiTab set seperated by comma's.

Remarks

1. CLUSTER# arranges data from a series of solutions selected by means of the Workbase right button menu options:

• • Solution-Add to Cluster
  • Solution-Remove from Cluster
  • Solution-Erase Cluster

1. These menu options in combination with the CLUSTER#() function allow you to select a number of solutions in the workbase and to retrieve and use their data in a new solution, e.g. for the automatic preparation of documents or to place a serie of result from solutions into a new solution to present differences etc..
2. Method 1 and 3 return a telitab, method 2 returns a document (large text without a particular meaning to Quaestor).

Examples

Method 1

This method will return a TeLiTab#. The syntax is

CLUSTER#(ObjName$)

in which ObjName$ is the name of the (multi-case) object to be the container of the solutions in the cluster.

If the cluster contains more than one solution, a multi-case TeLiTab# set will be returned:

0 1 StrExp { Telitab set of first solution in cluster } Telitab set of second solution in cluster . Telitab set of last solution in cluster }

If the cluster contains only one solution, CLUSTER#(ObjName$) returns a single case TeLiTab# set:

1 StrExp { Telitab set of solution in cluster  }

This TeLiTab set can be used by any other function as data source. 

 Method 2

This method will return a document:

CLUSTER#(0, "#LWL#,#B#", ", | and ", "NullString", 0, 1)

Parlist$ is "#LWL#,#B#". The parameters should be surrounded by # and can be delimited by comma's or spaces. It is also allowed to use # as delimiter but the parameter list should at least be started and closed by #, so "#LWL#B#" is also allowed.

CellDelim$ is ", | and ". The '|' will be the delimiter used for all clustered values except before the last one, e.g. four values will then be presented as "a, b, c and e".

ColArr$ is a "NullString".

IntSortCol% is 0.

IntAllowDoubles% is 1 to allow double values.

Method 3

This method will return a TeLiTab#:

CLUSTER#(1, A$, "0", B)

SearchPar is A$. Please note that A$ should be a DETERMINED value in the current solution. SearchPar is the key and any set of data from a solution which includes SearchPar is only added to the clustered dataset if the value of SearchPar is not yet present in this clustered dataset.

CaseNos$ is "0" to indicated that all available cases should be selected. If you want to have a particular set of cases of a solution, a list of cases should be provided, e.g. "3,4,5,6".

InpVar is B. The parameters should be given either with or without quotes (see also QuaestorSyntax). Please note that if you use the name without quotes the system will require a DETERMINED value of the parameter in the current solution.

Quick links: Functions overview | Attribute overview | Constants overview | Dimensions overview