def get_itervars(filter_expression="",
include_runattrs=False,
include_itervars=False,
include_param_assignments=False,
include_config_entries=False,
as_numeric=False):
"""
Returns a filtered list of iteration variables.
# Parameters
- **filter_expression** *(string)*: The filter expression to select the desired iteration variables.
Example: `name =~ iaMean AND config:Aloha.slotTime =~ 0`
- **include_runattrs**, **include_itervars**, **include_param_assignments**, **include_config_entries** *(bool)*:
Optional. When set to `True`, additional pieces of metadata about the run is appended to the result, pivoted into columns.
- **as_numeric** *(bool)*: Optional. When set to `True`, the returned values will be converted to `double`.
Non-numeric values will become `NaN`.
# Columns of the returned DataFrame
- **runID** *(string)*: Identifies the simulation run
- **name** *(string)*: The name of the iteration variable
- **value** *(string or double)*: The value of the iteration variable. Its type depends on the `as_numeric` parameter.
- Additional metadata items (run attributes, iteration variables, etc.), as requested
"""
return impl.get_itervars(**locals())
def get_itervars(filter_or_dataframe="",
include_runattrs=False,
include_itervars=False,
include_param_assignments=False,
include_config_entries=False):
"""
Returns a filtered list of iteration variables.
Parameters:
- `filter_or_dataframe` (string or dataframe): The filter expression to
select the desired iteration variables from the inputs, or a dataframe in
the "raw" format. Example: `name =~ iaMean AND config:Aloha.slotTime =~ 0`
- `include_runattrs`, `include_itervars`, `include_param_assignments`,
`include_config_entries` (bool): Optional. When set to `True`, additional
pieces of metadata about the run is appended to the result, pivoted into
columns. See the "Metadata columns" section of the module documentation
for details.
Columns of the returned DataFrame:
- `runID` (string): Identifies the simulation run
- `name` (string): The name of the iteration variable
- `value` (string): The value of the iteration variable.
- Additional metadata items (run attributes, iteration variables, etc.), as
requested
"""
if type(filter_or_dataframe) is str:
filter_expression = filter_or_dataframe
del filter_or_dataframe
return impl.get_itervars(**locals())
else:
df = filter_or_dataframe
itervars = df[df["type"] == "itervar"]
itervars = itervars[["runID", "attrname", "attrvalue"]]
itervars.rename(columns={
"attrname": "name",
"attrvalue": "value"
},
inplace=True)
itervars.reset_index(inplace=True, drop=True)
row_types = ["itervar", "runattr", "config"]
metadf = df[df["type"].isin(row_types)]
df = _pivot_metadata(itervars, metadf, include_runattrs,
include_itervars, include_param_assignments,
include_config_entries)
df.dropna(axis='columns', how='all', inplace=True)
return df
def get_itervars(filter_expression="",
include_runattrs=False,
include_itervars=False,
include_param_assignments=False,
include_config_entries=False):
"""
Returns a filtered list of iteration variables.
Parameters:
- `filter_expression` (string): The filter expression to select the desired iteration variables.
Example: `name =~ iaMean AND config:Aloha.slotTime =~ 0`
- `include_runattrs`, `include_itervars`, `include_param_assignments`, `include_config_entries` (bool):
Optional. When set to `True`, additional pieces of metadata about the run is appended to the result, pivoted into columns.
See the "Metadata columns" section of the module documentation for details.
Columns of the returned DataFrame:
- `runID` (string): Identifies the simulation run
- `name` (string): The name of the iteration variable
- `value` (string): The value of the iteration variable.
- Additional metadata items (run attributes, iteration variables, etc.), as requested
"""
return impl.get_itervars(**locals())