.. _`Rename columns in Tables with Table`:

.. _`org.sysess.sympathy.data.table.renametablecolumnstable`:

Rename columns in Tables with Table
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. image:: rename_columns.svg
   :width: 48


Rename columns in Tables by using an additional Table as a dictionary.

The dictionary Table must include one column with keywords and another
column with replacements. When the node is executed all column names in the
input Tables are checked against keyword column in the ditionary Table. If
a match is found the corresponding name in the replacement column will
replace the original column name.  For the case with no match the column
names are left unchanged.

If a name appears more than once in the keywords column of the dictionary
Table, that column will be renamed to each of the replacement names.
Esentially copying the single input column to several columns in the
output.

If a name appears more than once in the replacements column the last one
that is also present in the data table will be used. Also note that renamed
columns always take precedence over non-renamed ones.

:Ref. nodes: :ref:`Rename columns in Tables`

*Input ports*:
    :dictionary: table

        Dictionary
    :tables: [table]

        Input Tables

*Output ports*:
    :tables: [table]

        Tables with renamed columns

*Configuration*:
    **Keyword column** (source)
        Name of column containing old names
    **Replacement column** (destination)
        Name of column containing new names

.. automodule:: node_rename_columns

.. class:: RenameTableColumnsTables


Example flows
#############

* :download:`RenameColumnsInTable.syx </_examples/Sympathy/Data Processing/Structure/RenameColumnsInTable.syx>`