.. _data_fields:

DATA_FIELDS
############

An optional section where the names of the :ref:`type_field`, :ref:`id_field` and :ref:`time_field` can be redefined.

.. _data_fields_example:

Example Data Fields
============================

.. code-block:: pyml

    DATA_FIELDS:
        # Field name in data file that contains row type info, e.g. obs/dose etc
        type_field: TYPE

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

        # Field name in data file that contains time or event for each data row
        time_field: TIME

.. _data_fields_main_fields:
        
Main Fields
============

.. _type_field:

type_field
-----------

By default this field is:- 

.. code-block:: pyml
    
    type_field: TYPE

This means the 'TYPE' field in |data_file| specifies the type of row |eg| 'dose', 'obs', 'reset' etc.
    
.. _id_field:
    
id_field
----------

By default this field is:- 

.. code-block:: pyml
    
    id_field: ID

This means the 'ID' field in the |data_file| specifies the identity of each subject in the population.

.. _time_field:
    
time_field
------------

By default this field is:- 

.. code-block:: pyml
    
    time_field: TIME

This means the 'TIME' field in |data_file| specifies the time stamp of each observation, dose etc.


