create_mapping_rules()

Create Excel hyperlink formulas for components with representation maps.

Usage

Source

create_mapping_rules(
    components,
    rep_maps=None,
)

Parameters

components: Sequence[str]

A list or sequence of SDMX component IDs.

rep_maps: Set[str] | None = None

A set of component IDs for which a representation map exists and a hyperlink should be generated.

Returns

list[str]

A list of strings, where each element is either an Excel hyperlink

formula or an empty string.

Raises

TypeError

If any input argument fails type validation via

Examples

>>> components = ["FREQ", "REF_AREA", "SEX", "OBS_VALUE"]
>>> rep_maps = {"REF_AREA", "SEX"}
>>> create_mapping_rules(components, rep_maps)
['', '=HYPERLINK("#REF_AREA!A1","REF_AREA")', '=HYPERLINK("#SEX!A1","SEX")', '']

>>> create_mapping_rules(components, None)
['', '', '', '']

>>> create_mapping_rules([], {"ANY"})
[]