Differences
This shows you the differences between two versions of the page.
|
extract_struct_tuple [2020/04/28 12:43] argemiro created |
extract_struct_tuple [2026/08/28 03:19] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Extract Struct Tuple====== | + | ====== Extract Struct Tuple ====== |
| ===== Description ===== | ===== Description ===== | ||
| - | Extract a tuple from a Struct by it's name. | + | Extracts a tuple stored in a Struct, such as the one returned by [[Calculate R Expression]] or [[Calculate Python Expression]], by its name. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | Struct | [[struct_type|Struct]] | Struct to extract the tuple from. | | + | ^ Name ^ Type ^ Description ^ |
| - | | Name| [[string_type|String]] | Tuple name on struct. | | + | | Struct | [[Struct Type]] | Struct containing the tuple to extract. | |
| + | | Name | [[String Type]] | Name under which the tuple is stored in the struct. | | ||
| ===== Optional Inputs ===== | ===== Optional Inputs ===== | ||
| + | |||
| None. | None. | ||
| ===== Outputs ===== | ===== Outputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | Tuple| [[tuple_type|Tuple]] | Extracted tuple. | | + | ^ Name ^ Type ^ Description ^ |
| + | | Tuple | [[Tuple Type]] | Extracted tuple. | | ||
| ===== Group ===== | ===== Group ===== | ||
| Line 21: | Line 24: | ||
| [[Functor List#Integration | Integration]] | [[Functor List#Integration | Integration]] | ||
| - | ===== Internal Name ===== | + | ===== Notes ===== |
| + | |||
| + | Raises an error if no tuple is stored under Name in Struct. | ||
| + | |||
| + | This functor's banner shows the value of Name. | ||
| + | |||
| + | ===== Internal Name ===== | ||
| ExtractStructTuple | ExtractStructTuple | ||
| + | |||