Options#

MACPie has an options system that lets you customize some aspects of its behaviour and output.

Options have a “dotted-style”, case-insensitive name (e.g. display.max_rows).

The API is composed of 3 relevant functions, available directly from the macpie namespace:

Functions#

reset_option(key)

Reset one or more options to their default value. ::.

get_option(key)

Retrieves the value of the specified option. ::.

set_option(key, value)

Sets the value of the specified option. ::.

Available Options#

Option

Default

Function

dataset.id_col_name

“InstrID”

Default column name (case-sensitive) for the id_col_name value of a macpie.Dataset.

dataset.date_col_name

“DCDate”

Default column name (case-sensitive) for the date_col_name value of a macpie.Dataset.

dataset.id2_col_name

“PIDN”

Default column name (case-sensitive) for the id2_col_name value of a macpie.Dataset.

column.system.prefix

“_mp”

Column prefix for macpie.Dataset columns generated by MACPie.

operators.binary.column_suffixes

“_x”, “_y”

For binary operators, suffix to add to left and right macpie.Dataset columns, if applicable.