Difference between revisions of "MultiTable"
m |
|||
| Line 3: | Line 3: | ||
[[category:Table functions]] | [[category:Table functions]] | ||
| − | |||
| − | = MultiTable(i1,i2,...)(src1, src2, ...) = | + | == MultiTable(i1,i2,...)(src1, src2, ...) == |
| − | A [[MultiTable]] lets you mix editable and computed values in a single table. Editable cells are based on other variables, each defined as a [[ | + | A [[MultiTable]] lets you mix editable and computed values in a single table. Editable cells are based on other variables, each defined as a [[Table]] or [[SubTable]]. Computed values are based on calculated variables or expressions. When you change an editable cell, you are actually changing the original cell in the source table, not a copy. |
It is best practice in Analytica to keep different editable user inputs and computed results in different variables. But, it is often convenient to define part of a user interface that combines editable and computed values, which the [[MultiTable]] lets you do. | It is best practice in Analytica to keep different editable user inputs and computed results in different variables. But, it is often convenient to define part of a user interface that combines editable and computed values, which the [[MultiTable]] lets you do. | ||
For example, suppose <code>Startup_cost</code> and <code>Prob_success</code> are both edit tables, indexed by <code>Project</code>. Then the a variable defined as: | For example, suppose <code>Startup_cost</code> and <code>Prob_success</code> are both edit tables, indexed by <code>Project</code>. Then the a variable defined as: | ||
| − | :<code>Variable Project_inputs := | + | :<code>Variable Project_inputs := MultiTable(Item)(Startup_cost, Prob_success)</code> |
| + | |||
lets you view and edit both Startup_cost and Prob_Success in the same edit table, indexed by <code>Item</code> and <code>Project</code>. | lets you view and edit both Startup_cost and Prob_Success in the same edit table, indexed by <code>Item</code> and <code>Project</code>. | ||
[[MultiTable]] is the inverse of [[SubTable]] in that it combines multiple sources into one view, where [[SubTable]] selects a particular slice or subset of data to edit. | [[MultiTable]] is the inverse of [[SubTable]] in that it combines multiple sources into one view, where [[SubTable]] selects a particular slice or subset of data to edit. | ||
| − | = Creating a MultiTable = | + | == Creating a MultiTable == |
Before you create a [[MultiTable]], you need to create or identify one or more indexes that your data sources will vary over. For example, if you want a different data source to appear in each column of your table, then you'll need a column index, and you'll need to fill in the labels for each column as you define the index. | Before you create a [[MultiTable]], you need to create or identify one or more indexes that your data sources will vary over. For example, if you want a different data source to appear in each column of your table, then you'll need a column index, and you'll need to fill in the labels for each column as you define the index. | ||
| − | Next, create a variable to hold your [[MultiTable]] and press Ctrl+E to place your cursor in the definition field. | + | Next, create a variable to hold your [[MultiTable]] and press ''Ctrl+E'' to place your cursor in the definition field. |
| − | [[image:MT_create1.png]] | + | :[[image:MT_create1.png]] |
In the '''Object Finder''', select the '''Array''' library and scroll down to find and select [[MultiTable]]. Then, press the '''Indexes''' button. | In the '''Object Finder''', select the '''Array''' library and scroll down to find and select [[MultiTable]]. Then, press the '''Indexes''' button. | ||
| − | [[image:MT_create2.png]] | + | :[[image:MT_create2.png]] |
Select the indexes that your [[MultiTable]] data sources will vary along. These are not the indexes of your data sources themselves. | Select the indexes that your [[MultiTable]] data sources will vary along. These are not the indexes of your data sources themselves. | ||
| − | [[image:MT_create3.png]] | + | :[[image:MT_create3.png]] |
The table initially displays the "Meta expressions" view so that you can specify the data sources for the table. The ''meta-expression selector'' controls which view you are in. | The table initially displays the "Meta expressions" view so that you can specify the data sources for the table. The ''meta-expression selector'' controls which view you are in. | ||
| − | = Specifying Data Sources = | + | == Specifying Data Sources == |
Whenever you need to specify or change which data source should appear in a [[MultiTable]], use the ''meta-expressions selector'' to change to '''meta-expressions view'''. | Whenever you need to specify or change which data source should appear in a [[MultiTable]], use the ''meta-expressions selector'' to change to '''meta-expressions view'''. | ||
| Line 41: | Line 41: | ||
Here is an example of meta-expressions. | Here is an example of meta-expressions. | ||
| − | [[image:MT_create4.png]] | + | :[[image:MT_create4.png]] |
| − | In the above meta-expressions view, <code>Option_type</code>, <code>Stock_symbol</code>, <code>Strike_price</code> and <code>Expiration_date</code> are identifiers of other edit tables. These will be editable columns. <code>Stock_price_lookup(Stock_Symbol)</code> is a call to a [[User-Defined Function]], and its computed value will appear in this column. The last cell contains <code> | + | In the above meta-expressions view, <code>Option_type</code>, <code>Stock_symbol</code>, <code>Strike_price</code> and <code>Expiration_date</code> are identifiers of other edit tables. These will be editable columns. <code>Stock_price_lookup(Stock_Symbol)</code> is a call to a [[User-Defined Function]], and its computed value will appear in this column. The last cell contains <code>Mid(Contract_valuation)</code>, so that the computed mid-value of <code>Contract_valuation</code> will be displayed. When you want the computed value of a variable, you must surround its identifier with [[Mid]] in this fashion, otherwise its definition will appear in the cell and will be editable. |
| + | === Editable sources === | ||
| − | + | An editable source reflects the contents of another edit table in your model, a [[slice]] of an edit table, or the [[definition]] of another variable. When a user edits these cells in the multitable, they are actually changing the data in the specified source definition or table. In meta-expression view, an editable source is specified in one of the following ways. | |
| − | + | * <code>X</code> : An identifier. The definition of <code>X</code>, or the [[Table|edit table]] (or [[SubTable]] or [[MultiTable]] of <code>X</code>) is depicted. | |
| − | An editable source reflects the contents of another edit table in your model, a slice of an edit table, or the definition of another variable. When a user edits these cells in the multitable, they are actually changing the data in the specified source definition or table. In meta-expression view, an editable source is specified in one of the following ways. | ||
| − | * <code>X</code> : An identifier. The definition of X, or the [[Table|edit table]] (or [[SubTable]] or [[MultiTable]] of <code>X</code>) is depicted. | ||
* <code>X[I=v]</code> : A [[Slice]] or [[Subscript]] of another table. That slice is depicted in an editable form. | * <code>X[I=v]</code> : A [[Slice]] or [[Subscript]] of another table. That slice is depicted in an editable form. | ||
The source can be a scalar variable, an [[Table|edit table]], a [[SubTable]] or another [[MultiTable]]. Rather arbitrary transformations that be accomplished by nesting SubTables and MultiTables. | The source can be a scalar variable, an [[Table|edit table]], a [[SubTable]] or another [[MultiTable]]. Rather arbitrary transformations that be accomplished by nesting SubTables and MultiTables. | ||
| − | == Computed sources == | + | === Computed sources === |
The following are computed expressions, which are evaluated and the resulting value displayed in a non-editable form with a gray background. | The following are computed expressions, which are evaluated and the resulting value displayed in a non-editable form with a gray background. | ||
| Line 60: | Line 59: | ||
* <code>Mid(X)</code>: Displays the computed mid-value of the variable <code>X</code> | * <code>Mid(X)</code>: Displays the computed mid-value of the variable <code>X</code> | ||
* <code>F(...)</code>: Any function call other than [[Slice]] or [[Subscript]], including calls to [[User-Defined Function]]s, are evaluated. | * <code>F(...)</code>: Any function call other than [[Slice]] or [[Subscript]], including calls to [[User-Defined Function]]s, are evaluated. | ||
| − | * <code>x+y</code> : An expression, such as one involving arithmetic operations, is evaluated. | + | * <code>x + y</code> : An expression, such as one involving arithmetic operations, is evaluated. |
Here are a few additional examples: | Here are a few additional examples: | ||
| − | * <code>Mid(X)</code> : ''computes and displays the mid-value of X'' | + | * <code>Mid(X)</code> : ''computes and displays the [[mid]]-value of <code>X</code>'' |
| − | * <code> | + | * <code>Abs(X)</code> : ''displays the [[Abs|absolute value]] of the (mid-value) of <code>X</code>'' |
| − | * <code>Mean(X)</code> : ''computes and displays the mean of X'' | + | * <code>Mean(X)</code> : ''computes and displays the [[mean]] of <code>X</code>'' |
* <code>1.2</code> : ''displays the number, 1.2, in a non-editable cell'' | * <code>1.2</code> : ''displays the number, 1.2, in a non-editable cell'' | ||
* <code>"Some text"</code> : ''displays the text, without quotes, in a non-editable cell | * <code>"Some text"</code> : ''displays the text, without quotes, in a non-editable cell | ||
| Line 72: | Line 71: | ||
A computed expression or computed variable CAN depend on the values of other data sources that appear in the same [[MultiTable]]. When you do this, the computed value will change when the user changes the input cells and presses the green check button. | A computed expression or computed variable CAN depend on the values of other data sources that appear in the same [[MultiTable]]. When you do this, the computed value will change when the user changes the input cells and presses the green check button. | ||
| − | = Viewing the Data = | + | == Viewing the Data == |
After you have specified the data sources in meta-expression view, change the '''meta-expression selector''' to '''Show Cells''' to see the actual data. | After you have specified the data sources in meta-expression view, change the '''meta-expression selector''' to '''Show Cells''' to see the actual data. | ||
| − | [[image:MT_create5.png]] | + | :[[image:MT_create5.png]] |
| − | == When cells can be edited == | + | === When cells can be edited === |
You can never edit computed values in a [[MultiTable]] | You can never edit computed values in a [[MultiTable]] | ||
| − | In [[Browse mode]], you can edit data in a variable only if the variable has a [[user input node]]. This means that if your [[MultiTable]] variable has a user input node, users in [[Browse mode]] (including | + | In [[Browse mode]], you can edit data in a variable only if the variable has a [[user input node]]. This means that if your [[MultiTable]] variable has a user input node, users in [[Browse mode]] (including [[Analytica Cloud Player]] or [[Free Edition|Analytica Free 101]]) can edit all table sources. Otherwise, if one source has a user input node and another does not, users in [[Browse mode]] can edit only those cells from the source(s) with the user in. |
| − | = Examples = | + | == Examples == |
Here is an example of an editable value and computed value in the same table: | Here is an example of an editable value and computed value in the same table: | ||
| + | |||
| + | <pre style="background:white; border:white; margin-left: 1em;"> | ||
Index Base := ["Decimal", "Hex"] | Index Base := ["Decimal", "Hex"] | ||
Variable x := 123 | Variable x := 123 | ||
| − | Variable HexConverter := | + | Variable HexConverter := MultiTable(Base)(x, NumberToText(x, "Hexadecimal")) |
| + | </pre> | ||
The edit table displays like this: | The edit table displays like this: | ||
| − | |||
| − | |||
| − | = Dimensionality = | + | :[[image:HexConverter.png]] |
| + | |||
| + | The first cell can be edited, and when you change it and press the green check, the [[Binary and hexadecimal integer formats|hexadecimal]] value is computed and displayed. | ||
| + | |||
| + | == Dimensionality == | ||
The dimensions of the [[MultiTable]] content are the union of the indexes from all sources and of the [[MultiTable]] index(es). | The dimensions of the [[MultiTable]] content are the union of the indexes from all sources and of the [[MultiTable]] index(es). | ||
| Line 101: | Line 105: | ||
A [[MultiTable]] works best when your sources all have the same dimensionality. When one source does not have an index present in another source, a single cell in the source will map to multiple cells in the [[MultiTable]]; hence, you'll see the same value multiple places, and when you change it, multiple cells will change. The source retains its original dimensionality, so if the value doesn't vary along an index in the source, it won't vary along that index is the [[MultiTable]]. You may temporarily see a difference in these cells after you first enter a value, but they will become consistent as soon as you press the Green check. | A [[MultiTable]] works best when your sources all have the same dimensionality. When one source does not have an index present in another source, a single cell in the source will map to multiple cells in the [[MultiTable]]; hence, you'll see the same value multiple places, and when you change it, multiple cells will change. The source retains its original dimensionality, so if the value doesn't vary along an index in the source, it won't vary along that index is the [[MultiTable]]. You may temporarily see a difference in these cells after you first enter a value, but they will become consistent as soon as you press the Green check. | ||
| − | = Number Formats = | + | == Number Formats == |
When number formats are set for the source tables, those formats are used in the corresponding column of the MultiTable. | When number formats are set for the source tables, those formats are used in the corresponding column of the MultiTable. | ||
| − | When a meta-expression is of the form <code>Mid(X)</code>, then X's number format is used. For arbitrary expressions, the number format of the [[MultiTable]]'s own variable is used. | + | When a meta-expression is of the form <code>Mid(X)</code>, then <code>X</code>'s number format is used. For arbitrary expressions, the number format of the [[MultiTable]]'s own variable is used. |
| − | = | + | ==History== |
| + | Introduced in [[Analytica 4.6]]. Present in experimental form in [[Analytica 4.5]]. | ||
| + | == See Also == | ||
| + | * [[Working with Arrays (Tables)]] | ||
| + | * [[Arrays and Indexes]] | ||
* [[SubTable]] | * [[SubTable]] | ||
* [[Table]] | * [[Table]] | ||
* [[Mid]], [[Mean]], [[Sample]] -- used for specifying computed results. | * [[Mid]], [[Mean]], [[Sample]] -- used for specifying computed results. | ||
* [[Subscript]], [[Slice]], [[Subscript/Slice Operator]] | * [[Subscript]], [[Slice]], [[Subscript/Slice Operator]] | ||
| + | * [[Objects and Values]] | ||
Revision as of 18:54, 24 March 2016
MultiTable(i1,i2,...)(src1, src2, ...)
A MultiTable lets you mix editable and computed values in a single table. Editable cells are based on other variables, each defined as a Table or SubTable. Computed values are based on calculated variables or expressions. When you change an editable cell, you are actually changing the original cell in the source table, not a copy.
It is best practice in Analytica to keep different editable user inputs and computed results in different variables. But, it is often convenient to define part of a user interface that combines editable and computed values, which the MultiTable lets you do.
For example, suppose Startup_cost and Prob_success are both edit tables, indexed by Project. Then the a variable defined as:
Variable Project_inputs := MultiTable(Item)(Startup_cost, Prob_success)
lets you view and edit both Startup_cost and Prob_Success in the same edit table, indexed by Item and Project.
MultiTable is the inverse of SubTable in that it combines multiple sources into one view, where SubTable selects a particular slice or subset of data to edit.
Creating a MultiTable
Before you create a MultiTable, you need to create or identify one or more indexes that your data sources will vary over. For example, if you want a different data source to appear in each column of your table, then you'll need a column index, and you'll need to fill in the labels for each column as you define the index.
Next, create a variable to hold your MultiTable and press Ctrl+E to place your cursor in the definition field.
In the Object Finder, select the Array library and scroll down to find and select MultiTable. Then, press the Indexes button.
Select the indexes that your MultiTable data sources will vary along. These are not the indexes of your data sources themselves.
The table initially displays the "Meta expressions" view so that you can specify the data sources for the table. The meta-expression selector controls which view you are in.
Specifying Data Sources
Whenever you need to specify or change which data source should appear in a MultiTable, use the meta-expressions selector to change to meta-expressions view.
Here is an example of meta-expressions.
In the above meta-expressions view, Option_type, Stock_symbol, Strike_price and Expiration_date are identifiers of other edit tables. These will be editable columns. Stock_price_lookup(Stock_Symbol) is a call to a User-Defined Function, and its computed value will appear in this column. The last cell contains Mid(Contract_valuation), so that the computed mid-value of Contract_valuation will be displayed. When you want the computed value of a variable, you must surround its identifier with Mid in this fashion, otherwise its definition will appear in the cell and will be editable.
Editable sources
An editable source reflects the contents of another edit table in your model, a slice of an edit table, or the definition of another variable. When a user edits these cells in the multitable, they are actually changing the data in the specified source definition or table. In meta-expression view, an editable source is specified in one of the following ways.
X: An identifier. The definition ofX, or the edit table (or SubTable or MultiTable ofX) is depicted.X[I=v]: A Slice or Subscript of another table. That slice is depicted in an editable form.
The source can be a scalar variable, an edit table, a SubTable or another MultiTable. Rather arbitrary transformations that be accomplished by nesting SubTables and MultiTables.
Computed sources
The following are computed expressions, which are evaluated and the resulting value displayed in a non-editable form with a gray background.
31.4,"Text": Literal values (numbers, quoted text)Mid(X): Displays the computed mid-value of the variableXF(...): Any function call other than Slice or Subscript, including calls to User-Defined Functions, are evaluated.x + y: An expression, such as one involving arithmetic operations, is evaluated.
Here are a few additional examples:
Mid(X): computes and displays the mid-value ofXAbs(X): displays the absolute value of the (mid-value) ofXMean(X): computes and displays the mean ofX1.2: displays the number, 1.2, in a non-editable cell"Some text": displays the text, without quotes, in a non-editable cell
A computed expression or computed variable CAN depend on the values of other data sources that appear in the same MultiTable. When you do this, the computed value will change when the user changes the input cells and presses the green check button.
Viewing the Data
After you have specified the data sources in meta-expression view, change the meta-expression selector to Show Cells to see the actual data.
When cells can be edited
You can never edit computed values in a MultiTable
In Browse mode, you can edit data in a variable only if the variable has a user input node. This means that if your MultiTable variable has a user input node, users in Browse mode (including Analytica Cloud Player or Analytica Free 101) can edit all table sources. Otherwise, if one source has a user input node and another does not, users in Browse mode can edit only those cells from the source(s) with the user in.
Examples
Here is an example of an editable value and computed value in the same table:
Index Base := ["Decimal", "Hex"] Variable x := 123 Variable HexConverter := MultiTable(Base)(x, NumberToText(x, "Hexadecimal"))
The edit table displays like this:
The first cell can be edited, and when you change it and press the green check, the hexadecimal value is computed and displayed.
Dimensionality
The dimensions of the MultiTable content are the union of the indexes from all sources and of the MultiTable index(es).
A MultiTable works best when your sources all have the same dimensionality. When one source does not have an index present in another source, a single cell in the source will map to multiple cells in the MultiTable; hence, you'll see the same value multiple places, and when you change it, multiple cells will change. The source retains its original dimensionality, so if the value doesn't vary along an index in the source, it won't vary along that index is the MultiTable. You may temporarily see a difference in these cells after you first enter a value, but they will become consistent as soon as you press the Green check.
Number Formats
When number formats are set for the source tables, those formats are used in the corresponding column of the MultiTable.
When a meta-expression is of the form Mid(X), then X's number format is used. For arbitrary expressions, the number format of the MultiTable's own variable is used.
History
Introduced in Analytica 4.6. Present in experimental form in Analytica 4.5.
See Also
- Working with Arrays (Tables)
- Arrays and Indexes
- SubTable
- Table
- Mid, Mean, Sample -- used for specifying computed results.
- Subscript, Slice, Subscript/Slice Operator
- Objects and Values
Enable comment auto-refresher