:orphan:

.. The content of this file was generated
.. automatically by the popy.conf.fio.rstdoc_writer module
.. at 19 Mar 2026, 01:37:10


.. _merge_spec:



.. _merge-x-method-options-x-spec:

METHOD_OPTIONS
**************

Type: :term:`dict_record <dict_record>`

method options for dat_merge

Example:-

.. code-block:: pyml

    METHOD_OPTIONS:
        py_module: merge


.. _merge-x-method-options-x-py-module-x-spec:

py_module
=========

Type: :term:`one_of(merge) <one_of>`

Python module required to process this script file

Example:-

.. code-block:: pyml

    py_module: merge


.. _merge-x-file-paths-x-spec:

FILE_PATHS
**********

Type: :term:`dict_record <dict_record>`

file paths record

Example:-

.. code-block:: pyml

    FILE_PATHS:
        input_csv_file_list: ['./path_to_csv_file', './path_to_another_csv_file']
        input_ssv_file_list: ['./path_to_ssv_file', './path_to_another_ssv_file']
        output_folder: auto


.. _merge-x-file-paths-x-input-csv-file-list-x-spec:

input_csv_file_list
===================

Type: :term:`list <list>`

List of comma separated variable files to load in and merge
 - must have same number of rows.

Example:-

.. code-block:: pyml

    input_csv_file_list: ['./path_to_csv_file', './path_to_another_csv_file']


.. _merge-x-file-paths-x-input-ssv-file-list-x-spec:

input_ssv_file_list
===================

Type: :term:`list <list>`

List of space separated variable files to load in and merge
 - must have same number of rows.

Example:-

.. code-block:: pyml

    input_ssv_file_list: ['./path_to_ssv_file', './path_to_another_ssv_file']


.. _merge-x-file-paths-x-output-folder-x-spec:

output_folder
=============

Type: :term:`output_folder <output_folder>` / :term:`auto <auto>`

Output folder - results of computation stored here

Example:-

.. code-block:: pyml

    output_folder: auto


.. _merge-x-data-fields-x-spec:

DATA_FIELDS
***********

Type: :term:`dict_record <dict_record>`

data fields for popy.dat.fields object

Example:-

.. code-block:: pyml

    DATA_FIELDS:
        type_field: TYPE
        id_field: ID
        time_field: TIME


.. _merge-x-data-fields-x-type-field-x-spec:

type_field
==========

Type: :term:`str <str>`

Field name in data file that contains row type info, e.g. obs/dose etc

Example:-

.. code-block:: pyml

    type_field: TYPE


.. _merge-x-data-fields-x-id-field-x-spec:

id_field
========

Type: :term:`str <str>`

Field name in data file that contains identity string for each data row e.g. obs/dose etc

Example:-

.. code-block:: pyml

    id_field: ID


.. _merge-x-data-fields-x-time-field-x-spec:

time_field
==========

Type: :term:`str <str>`

Field name in data file that contains time or event for each data row

Example:-

.. code-block:: pyml

    time_field: TIME



