:orphan:

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


.. _grph_spec:



.. _grph-x-method-options-x-spec:

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

Type: :term:`dict_record <dict_record>`

method options for plt_grph

Example:-

.. code-block:: pyml

    METHOD_OPTIONS:
        py_module: grph


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

py_module
=========

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

Python module required to process this script file

Example:-

.. code-block:: pyml

    py_module: grph


.. _grph-x-parallel-x-spec:

PARALLEL
********

Type: :term:`one_of_record <one_of_record>`

one of many possible servers

Example:-

.. code-block:: pyml

    PARALLEL:
        SINGLE: {progress_bar_length: 0}


.. _grph-x-parallel-x-single-x-spec:

SINGLE
======

Type: :term:`dict_record <dict_record>`

single process server spec.

Example:-

.. code-block:: pyml

    SINGLE:
        progress_bar_length: 0


.. _grph-x-parallel-x-single-x-progress-bar-length-x-spec:

progress_bar_length
-------------------

Type: :term:`int <int>`

Length of progress bar on screen (default=0, off)

Example:-

.. code-block:: pyml

    progress_bar_length: 0


.. _grph-x-parallel-x-mpi-workers-x-spec:

MPI_WORKERS
===========

Type: :term:`dict_record <dict_record>`

MPI local server spec.

Example:-

.. code-block:: pyml

    MPI_WORKERS:
        n_workers: auto
        cpu_load: 1.0
        progress_bar_length: 0


.. _grph-x-parallel-x-mpi-workers-x-n-workers-x-spec:

n_workers
---------

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

Number of workers to use on this machine, defaults to number of processors, but could be more or fewer.

Example:-

.. code-block:: pyml

    n_workers: auto


.. _grph-x-parallel-x-mpi-workers-x-cpu-load-x-spec:

cpu_load
--------

Type: :term:`float <float>`

Desired load on CPU as a decimal greater than 0.0 (0%) and less than or equal to 1.0 (100%)

Example:-

.. code-block:: pyml

    cpu_load: 1.0


.. _grph-x-parallel-x-mpi-workers-x-progress-bar-length-x-spec:

progress_bar_length
-------------------

Type: :term:`int <int>`

Length of progress bar on screen (default=0, off)

Example:-

.. code-block:: pyml

    progress_bar_length: 0


.. _grph-x-file-paths-x-spec:

FILE_PATHS
**********

Type: :term:`dict_record <dict_record>`

file paths

Example:-

.. code-block:: pyml

    FILE_PATHS:
        output_folder: auto
        log_folder: auto
        output_file_ext: ['svg']
        delete_old_files_flag: False
        solutions:
            initial_fit_ipred: sol0/solution.pyml
            final_fit_ipred: solN/solution.pyml


.. _grph-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


.. _grph-x-file-paths-x-log-folder-x-spec:

log_folder
==========

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

Log folder - log files stored here

Example:-

.. code-block:: pyml

    log_folder: auto


.. _grph-x-file-paths-x-output-file-ext-x-spec:

output_file_ext
===============

Type: :term:`list_of(pdf,png,svg) <list_of>`

Output file extension - determines graphical output file format.

Example:-

.. code-block:: pyml

    output_file_ext: ['svg']


.. _grph-x-file-paths-x-delete-old-files-flag-x-spec:

delete_old_files_flag
=====================

Type: :term:`bool <bool>`

Option to delete any existing files before running.

Example:-

.. code-block:: pyml

    delete_old_files_flag: False


.. _grph-x-file-paths-x-solutions-x-spec:

solutions
=========

Type: :term:`dict <dict>`

Solutions to compare

Example:-

.. code-block:: pyml

    solutions:
        initial_fit_ipred: sol0/solution.pyml
        final_fit_ipred: solN/solution.pyml


.. _grph-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


.. _grph-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


.. _grph-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


.. _grph-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


.. _grph-x-preprocess-x-spec:

PREPROCESS
**********

Type: :term:`verbatim <verbatim>`

Code that preprocesses the input data.
Use this to filter rows and create derived covariates.

Example:-

.. code-block:: pyml

    PREPROCESS: |


.. _grph-x-output-graphs-x-spec:

OUTPUT_GRAPHS
*************

Type: :term:`list_record <list_record>`

List of graphs to output.

Example:-

.. code-block:: pyml

    OUTPUT_GRAPHS:
        - COMB_SPAG_GRPH:
            output_subdir: none
            graph_title: My rather excellent graph
            x_axis_label: TIME
            x_var: TIME
            x_scale: linear
            y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']
            y_var_src_list: ['observed_data', 'final_fit_ppred', 'final_fit_ipred']
            y_var_list: ['DV_CENTRAL', 'DV_CENTRAL', 'DV_CENTRAL']
            y_var_label_list: ['Drug conc. (units)', 'Drug conc. (units)', 'Drug conc. (units)']
            y_var_colour_list: ['b', 'g']
            y_var_symbol_list: ['-', '-']
            y_scale_list: ['linear', 'log']
            options_list: ['legend', 'grid', 'dose_lines']

        - SCATTER_GRPH:
            output_subdir: none
            graph_title: My rather excellent graph
            x_axis_label: TIME
            x_var_src: observed_data
            x_var: TIME
            x_scale: linear
            y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']
            y_var_src_list: ['observed_data', 'final_fit_ppred', 'final_fit_ipred']
            y_var_list: ['DV_CENTRAL', 'DV_CENTRAL', 'DV_CENTRAL']
            y_var_label_list: ['Drug conc. (units)', 'Drug conc. (units)', 'Drug conc. (units)']
            y_var_colour_list: ['b', 'g']
            y_var_symbol_list: ['-', '-']
            y_scale_list: ['linear', 'log']
            options_list: ['legend', 'grid', 'dose_lines']
            dot_size: 12

        - RES_VS_X_GRPH:
            output_subdir: none
            graph_title: My rather excellent graph
            x_axis_label: TIME
            x_var_src: observed_data
            x_var: TIME
            x_scale: linear
            y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']
            y_var_src_list: ['observed_data', 'final_fit_ppred', 'final_fit_ipred']
            y_var_list: ['DV_CENTRAL', 'DV_CENTRAL', 'DV_CENTRAL']
            y_var_label_list: ['Drug conc. (units)', 'Drug conc. (units)', 'Drug conc. (units)']
            y_var_colour_list: ['b', 'g']
            y_var_symbol_list: ['-', '-']
            y_scale_list: ['linear', 'log']
            options_list: ['legend', 'grid', 'dose_lines']
            dot_size: 12

        - WRES_VS_X_GRPH:
            output_subdir: none
            graph_title: My rather excellent graph
            x_axis_label: TIME
            x_var_src: observed_data
            x_var: TIME
            x_scale: linear
            y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']
            y_var_src_list: ['observed_data', 'final_fit_ppred', 'final_fit_ipred']
            y_var_list: ['DV_CENTRAL', 'DV_CENTRAL', 'DV_CENTRAL']
            y_var_label_list: ['Drug conc. (units)', 'Drug conc. (units)', 'Drug conc. (units)']
            y_var_colour_list: ['b', 'g']
            y_var_symbol_list: ['-', '-']
            y_scale_list: ['linear', 'log']
            options_list: ['legend', 'grid', 'dose_lines']
            dot_size: 12

        - CWRES_VS_X_GRPH:
            output_subdir: none
            graph_title: My rather excellent graph
            x_axis_label: TIME
            x_var_src: observed_data
            x_var: TIME
            x_scale: linear
            y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']
            y_var_src_list: ['observed_data', 'final_fit_ppred', 'final_fit_ipred']
            y_var_list: ['DV_CENTRAL', 'DV_CENTRAL', 'DV_CENTRAL']
            y_var_label_list: ['Drug conc. (units)', 'Drug conc. (units)', 'Drug conc. (units)']
            y_var_colour_list: ['b', 'g']
            y_var_symbol_list: ['-', '-']
            y_scale_list: ['linear', 'log']
            options_list: ['legend', 'grid', 'dose_lines']
            dot_size: 12

        - SPAG_GRPH:
            output_subdir: none
            graph_title: My rather excellent graph
            x_axis_label: TIME
            x_var: TIME
            x_scale: linear
            y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']
            y_var_src_list: ['observed_data', 'final_fit_ppred', 'final_fit_ipred']
            y_var_list: ['DV_CENTRAL', 'DV_CENTRAL', 'DV_CENTRAL']
            y_var_label_list: ['Drug conc. (units)', 'Drug conc. (units)', 'Drug conc. (units)']
            y_var_colour_list: ['b', 'g']
            y_var_symbol_list: ['-', '-']
            y_scale_list: ['linear', 'log']
            options_list: ['legend', 'grid', 'dose_lines']


.. _grph-x-output-graphs-x-comb-spag-grph-x-spec:

COMB_SPAG_GRPH
==============

Type: :term:`dict_record <dict_record>`

Plot data for all individuals one one graph.

Example:-

.. code-block:: pyml

    COMB_SPAG_GRPH:
        output_subdir: none
        graph_title: My rather excellent graph
        x_axis_label: TIME
        x_var: TIME
        x_scale: linear
        y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']
        y_var_src_list: ['observed_data', 'final_fit_ppred', 'final_fit_ipred']
        y_var_list: ['DV_CENTRAL', 'DV_CENTRAL', 'DV_CENTRAL']
        y_var_label_list: ['Drug conc. (units)', 'Drug conc. (units)', 'Drug conc. (units)']
        y_var_colour_list: ['b', 'g']
        y_var_symbol_list: ['-', '-']
        y_scale_list: ['linear', 'log']
        options_list: ['legend', 'grid', 'dose_lines']


.. _grph-x-output-graphs-x-comb-spag-grph-x-output-subdir-x-spec:

output_subdir
-------------

Type: :term:`output_folder <output_folder>`

Destination subdirectory for these plots.

Example:-

.. code-block:: pyml

    output_subdir: none


.. _grph-x-output-graphs-x-comb-spag-grph-x-graph-title-x-spec:

graph_title
-----------

Type: :term:`str <str>`

Title of graph.

Example:-

.. code-block:: pyml

    graph_title: My rather excellent graph


.. _grph-x-output-graphs-x-comb-spag-grph-x-x-axis-label-x-spec:

x_axis_label
------------

Type: :term:`str <str>`

x axis label text

Example:-

.. code-block:: pyml

    x_axis_label: TIME


.. _grph-x-output-graphs-x-comb-spag-grph-x-x-var-x-spec:

x_var
-----

Type: :term:`str <str>`

x axis variable name.

Example:-

.. code-block:: pyml

    x_var: TIME


.. _grph-x-output-graphs-x-comb-spag-grph-x-x-scale-x-spec:

x_scale
-------

Type: :term:`one_of(linear,log) <one_of>`

x axis scale - can be either 'linear' or 'log'.

Example:-

.. code-block:: pyml

    x_scale: linear


.. _grph-x-output-graphs-x-comb-spag-grph-x-y-axis-label-list-x-spec:

y_axis_label_list
-----------------

Type: :term:`list(str) <list>`

List of labels for y variables that appear on axes.

Example:-

.. code-block:: pyml

    y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']


.. _grph-x-output-graphs-x-comb-spag-grph-x-y-var-src-list-x-spec:

y_var_src_list
--------------

Type: :term:`list(str) <list>`

Names of the solution folders that contain the predictions to be plotted

Example:-

.. code-block:: pyml

    y_var_src_list: ['observed_data', 'final_fit_ppred', 'final_fit_ipred']


.. _grph-x-output-graphs-x-comb-spag-grph-x-y-var-list-x-spec:

y_var_list
----------

Type: :term:`list(str) <list>`

List of y variable names (i.e. columns in the predictions table) to be plotted on graph.

Example:-

.. code-block:: pyml

    y_var_list: ['DV_CENTRAL', 'DV_CENTRAL', 'DV_CENTRAL']


.. _grph-x-output-graphs-x-comb-spag-grph-x-y-var-label-list-x-spec:

y_var_label_list
----------------

Type: :term:`list(str) <list>`

List of y variable labels which will appear in the legend as <y_var_label> (<y_var_src>).

Example:-

.. code-block:: pyml

    y_var_label_list: ['Drug conc. (units)', 'Drug conc. (units)', 'Drug conc. (units)']


.. _grph-x-output-graphs-x-comb-spag-grph-x-y-var-colour-list-x-spec:

y_var_colour_list
-----------------

Type: :term:`list(str) <list>`

List of colours for y variable plot lines.

Example:-

.. code-block:: pyml

    y_var_colour_list: ['b', 'g']


.. _grph-x-output-graphs-x-comb-spag-grph-x-y-var-symbol-list-x-spec:

y_var_symbol_list
-----------------

Type: :term:`list(str) <list>`

List of plot line styles for y variable plot lines.

Example:-

.. code-block:: pyml

    y_var_symbol_list: ['-', '-']


.. _grph-x-output-graphs-x-comb-spag-grph-x-y-scale-list-x-spec:

y_scale_list
------------

Type: :term:`list(str) <list>`

List of scales (linear or log) for multiple y axes.

Example:-

.. code-block:: pyml

    y_scale_list: ['linear', 'log']


.. _grph-x-output-graphs-x-comb-spag-grph-x-options-list-x-spec:

options_list
------------

Type: :term:`list_of(legend,legend_above,grid,dose_lines,share_axes,sim_xy,square,45degree_line,linreg_line,gaussreg_line) <list_of>`

List of visual options to apply to individual plots.

Example:-

.. code-block:: pyml

    options_list: ['legend', 'grid', 'dose_lines']


.. _grph-x-output-graphs-x-scatter-grph-x-spec:

SCATTER_GRPH
============

Type: :term:`dict_record <dict_record>`

Scatter plot for all individuals on a single graph.

Example:-

.. code-block:: pyml

    SCATTER_GRPH:
        output_subdir: none
        graph_title: My rather excellent graph
        x_axis_label: TIME
        x_var_src: observed_data
        x_var: TIME
        x_scale: linear
        y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']
        y_var_src_list: ['observed_data', 'final_fit_ppred', 'final_fit_ipred']
        y_var_list: ['DV_CENTRAL', 'DV_CENTRAL', 'DV_CENTRAL']
        y_var_label_list: ['Drug conc. (units)', 'Drug conc. (units)', 'Drug conc. (units)']
        y_var_colour_list: ['b', 'g']
        y_var_symbol_list: ['-', '-']
        y_scale_list: ['linear', 'log']
        options_list: ['legend', 'grid', 'dose_lines']
        dot_size: 12


.. _grph-x-output-graphs-x-scatter-grph-x-output-subdir-x-spec:

output_subdir
-------------

Type: :term:`output_folder <output_folder>`

Destination subdirectory for these plots.

Example:-

.. code-block:: pyml

    output_subdir: none


.. _grph-x-output-graphs-x-scatter-grph-x-graph-title-x-spec:

graph_title
-----------

Type: :term:`str <str>`

Title of graph.

Example:-

.. code-block:: pyml

    graph_title: My rather excellent graph


.. _grph-x-output-graphs-x-scatter-grph-x-x-axis-label-x-spec:

x_axis_label
------------

Type: :term:`str <str>`

x axis label text

Example:-

.. code-block:: pyml

    x_axis_label: TIME


.. _grph-x-output-graphs-x-scatter-grph-x-x-var-src-x-spec:

x_var_src
---------

Type: :term:`str <str>`

Name of the folder containing the solution.pyml and predictions.csv for the data on the x-axis.

Example:-

.. code-block:: pyml

    x_var_src: observed_data


.. _grph-x-output-graphs-x-scatter-grph-x-x-var-x-spec:

x_var
-----

Type: :term:`str <str>`

x axis variable name.

Example:-

.. code-block:: pyml

    x_var: TIME


.. _grph-x-output-graphs-x-scatter-grph-x-x-scale-x-spec:

x_scale
-------

Type: :term:`one_of(linear,log) <one_of>`

x axis scale - can be either 'linear' or 'log'.

Example:-

.. code-block:: pyml

    x_scale: linear


.. _grph-x-output-graphs-x-scatter-grph-x-y-axis-label-list-x-spec:

y_axis_label_list
-----------------

Type: :term:`list(str) <list>`

List of labels for y variables that appear on axes.

Example:-

.. code-block:: pyml

    y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']


.. _grph-x-output-graphs-x-scatter-grph-x-y-var-src-list-x-spec:

y_var_src_list
--------------

Type: :term:`list(str) <list>`

Names of the solution folders that contain the predictions to be plotted

Example:-

.. code-block:: pyml

    y_var_src_list: ['observed_data', 'final_fit_ppred', 'final_fit_ipred']


.. _grph-x-output-graphs-x-scatter-grph-x-y-var-list-x-spec:

y_var_list
----------

Type: :term:`list(str) <list>`

List of y variable names (i.e. columns in the predictions table) to be plotted on graph.

Example:-

.. code-block:: pyml

    y_var_list: ['DV_CENTRAL', 'DV_CENTRAL', 'DV_CENTRAL']


.. _grph-x-output-graphs-x-scatter-grph-x-y-var-label-list-x-spec:

y_var_label_list
----------------

Type: :term:`list(str) <list>`

List of y variable labels which will appear in the legend as <y_var_label> (<y_var_src>).

Example:-

.. code-block:: pyml

    y_var_label_list: ['Drug conc. (units)', 'Drug conc. (units)', 'Drug conc. (units)']


.. _grph-x-output-graphs-x-scatter-grph-x-y-var-colour-list-x-spec:

y_var_colour_list
-----------------

Type: :term:`list(str) <list>`

List of colours for y variable plot lines.

Example:-

.. code-block:: pyml

    y_var_colour_list: ['b', 'g']


.. _grph-x-output-graphs-x-scatter-grph-x-y-var-symbol-list-x-spec:

y_var_symbol_list
-----------------

Type: :term:`list(str) <list>`

List of plot line styles for y variable plot lines.

Example:-

.. code-block:: pyml

    y_var_symbol_list: ['-', '-']


.. _grph-x-output-graphs-x-scatter-grph-x-y-scale-list-x-spec:

y_scale_list
------------

Type: :term:`list(str) <list>`

List of scales (linear or log) for multiple y axes.

Example:-

.. code-block:: pyml

    y_scale_list: ['linear', 'log']


.. _grph-x-output-graphs-x-scatter-grph-x-options-list-x-spec:

options_list
------------

Type: :term:`list_of(legend,legend_above,grid,dose_lines,share_axes,sim_xy,square,45degree_line,linreg_line,gaussreg_line) <list_of>`

List of visual options to apply to individual plots.

Example:-

.. code-block:: pyml

    options_list: ['legend', 'grid', 'dose_lines']


.. _grph-x-output-graphs-x-scatter-grph-x-dot-size-x-spec:

dot_size
--------

Type: :term:`int <int>`

Size of dots appearing in scatter plots

Example:-

.. code-block:: pyml

    dot_size: 12


.. _grph-x-output-graphs-x-res-vs-x-grph-x-spec:

RES_VS_X_GRPH
=============

Type: :term:`dict_record <dict_record>`

Scatter plot for all individuals on a single graph.

Example:-

.. code-block:: pyml

    RES_VS_X_GRPH:
        output_subdir: none
        graph_title: My rather excellent graph
        x_axis_label: TIME
        x_var_src: observed_data
        x_var: TIME
        x_scale: linear
        y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']
        y_var_src_list: ['observed_data', 'final_fit_ppred', 'final_fit_ipred']
        y_var_list: ['DV_CENTRAL', 'DV_CENTRAL', 'DV_CENTRAL']
        y_var_label_list: ['Drug conc. (units)', 'Drug conc. (units)', 'Drug conc. (units)']
        y_var_colour_list: ['b', 'g']
        y_var_symbol_list: ['-', '-']
        y_scale_list: ['linear', 'log']
        options_list: ['legend', 'grid', 'dose_lines']
        dot_size: 12


.. _grph-x-output-graphs-x-res-vs-x-grph-x-output-subdir-x-spec:

output_subdir
-------------

Type: :term:`output_folder <output_folder>`

Destination subdirectory for these plots.

Example:-

.. code-block:: pyml

    output_subdir: none


.. _grph-x-output-graphs-x-res-vs-x-grph-x-graph-title-x-spec:

graph_title
-----------

Type: :term:`str <str>`

Title of graph.

Example:-

.. code-block:: pyml

    graph_title: My rather excellent graph


.. _grph-x-output-graphs-x-res-vs-x-grph-x-x-axis-label-x-spec:

x_axis_label
------------

Type: :term:`str <str>`

x axis label text

Example:-

.. code-block:: pyml

    x_axis_label: TIME


.. _grph-x-output-graphs-x-res-vs-x-grph-x-x-var-src-x-spec:

x_var_src
---------

Type: :term:`str <str>`

Name of the folder containing the solution.pyml and predictions.csv for the data on the x-axis.

Example:-

.. code-block:: pyml

    x_var_src: observed_data


.. _grph-x-output-graphs-x-res-vs-x-grph-x-x-var-x-spec:

x_var
-----

Type: :term:`str <str>`

x axis variable name.

Example:-

.. code-block:: pyml

    x_var: TIME


.. _grph-x-output-graphs-x-res-vs-x-grph-x-x-scale-x-spec:

x_scale
-------

Type: :term:`one_of(linear,log) <one_of>`

x axis scale - can be either 'linear' or 'log'.

Example:-

.. code-block:: pyml

    x_scale: linear


.. _grph-x-output-graphs-x-res-vs-x-grph-x-y-axis-label-list-x-spec:

y_axis_label_list
-----------------

Type: :term:`list(str) <list>`

List of labels for y variables that appear on axes.

Example:-

.. code-block:: pyml

    y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']


.. _grph-x-output-graphs-x-res-vs-x-grph-x-y-var-src-list-x-spec:

y_var_src_list
--------------

Type: :term:`list(str) <list>`

Names of the solution folders that contain the predictions to be plotted

Example:-

.. code-block:: pyml

    y_var_src_list: ['observed_data', 'final_fit_ppred', 'final_fit_ipred']


.. _grph-x-output-graphs-x-res-vs-x-grph-x-y-var-list-x-spec:

y_var_list
----------

Type: :term:`list(str) <list>`

List of y variable names (i.e. columns in the predictions table) to be plotted on graph.

Example:-

.. code-block:: pyml

    y_var_list: ['DV_CENTRAL', 'DV_CENTRAL', 'DV_CENTRAL']


.. _grph-x-output-graphs-x-res-vs-x-grph-x-y-var-label-list-x-spec:

y_var_label_list
----------------

Type: :term:`list(str) <list>`

List of y variable labels which will appear in the legend as <y_var_label> (<y_var_src>).

Example:-

.. code-block:: pyml

    y_var_label_list: ['Drug conc. (units)', 'Drug conc. (units)', 'Drug conc. (units)']


.. _grph-x-output-graphs-x-res-vs-x-grph-x-y-var-colour-list-x-spec:

y_var_colour_list
-----------------

Type: :term:`list(str) <list>`

List of colours for y variable plot lines.

Example:-

.. code-block:: pyml

    y_var_colour_list: ['b', 'g']


.. _grph-x-output-graphs-x-res-vs-x-grph-x-y-var-symbol-list-x-spec:

y_var_symbol_list
-----------------

Type: :term:`list(str) <list>`

List of plot line styles for y variable plot lines.

Example:-

.. code-block:: pyml

    y_var_symbol_list: ['-', '-']


.. _grph-x-output-graphs-x-res-vs-x-grph-x-y-scale-list-x-spec:

y_scale_list
------------

Type: :term:`list(str) <list>`

List of scales (linear or log) for multiple y axes.

Example:-

.. code-block:: pyml

    y_scale_list: ['linear', 'log']


.. _grph-x-output-graphs-x-res-vs-x-grph-x-options-list-x-spec:

options_list
------------

Type: :term:`list_of(legend,legend_above,grid,dose_lines,share_axes,sim_xy,square,45degree_line,linreg_line,gaussreg_line) <list_of>`

List of visual options to apply to individual plots.

Example:-

.. code-block:: pyml

    options_list: ['legend', 'grid', 'dose_lines']


.. _grph-x-output-graphs-x-res-vs-x-grph-x-dot-size-x-spec:

dot_size
--------

Type: :term:`int <int>`

Size of dots appearing in scatter plots

Example:-

.. code-block:: pyml

    dot_size: 12


.. _grph-x-output-graphs-x-wres-vs-x-grph-x-spec:

WRES_VS_X_GRPH
==============

Type: :term:`dict_record <dict_record>`

Scatter plot for all individuals on a single graph.

Example:-

.. code-block:: pyml

    WRES_VS_X_GRPH:
        output_subdir: none
        graph_title: My rather excellent graph
        x_axis_label: TIME
        x_var_src: observed_data
        x_var: TIME
        x_scale: linear
        y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']
        y_var_src_list: ['observed_data', 'final_fit_ppred', 'final_fit_ipred']
        y_var_list: ['DV_CENTRAL', 'DV_CENTRAL', 'DV_CENTRAL']
        y_var_label_list: ['Drug conc. (units)', 'Drug conc. (units)', 'Drug conc. (units)']
        y_var_colour_list: ['b', 'g']
        y_var_symbol_list: ['-', '-']
        y_scale_list: ['linear', 'log']
        options_list: ['legend', 'grid', 'dose_lines']
        dot_size: 12


.. _grph-x-output-graphs-x-wres-vs-x-grph-x-output-subdir-x-spec:

output_subdir
-------------

Type: :term:`output_folder <output_folder>`

Destination subdirectory for these plots.

Example:-

.. code-block:: pyml

    output_subdir: none


.. _grph-x-output-graphs-x-wres-vs-x-grph-x-graph-title-x-spec:

graph_title
-----------

Type: :term:`str <str>`

Title of graph.

Example:-

.. code-block:: pyml

    graph_title: My rather excellent graph


.. _grph-x-output-graphs-x-wres-vs-x-grph-x-x-axis-label-x-spec:

x_axis_label
------------

Type: :term:`str <str>`

x axis label text

Example:-

.. code-block:: pyml

    x_axis_label: TIME


.. _grph-x-output-graphs-x-wres-vs-x-grph-x-x-var-src-x-spec:

x_var_src
---------

Type: :term:`str <str>`

Name of the folder containing the solution.pyml and predictions.csv for the data on the x-axis.

Example:-

.. code-block:: pyml

    x_var_src: observed_data


.. _grph-x-output-graphs-x-wres-vs-x-grph-x-x-var-x-spec:

x_var
-----

Type: :term:`str <str>`

x axis variable name.

Example:-

.. code-block:: pyml

    x_var: TIME


.. _grph-x-output-graphs-x-wres-vs-x-grph-x-x-scale-x-spec:

x_scale
-------

Type: :term:`one_of(linear,log) <one_of>`

x axis scale - can be either 'linear' or 'log'.

Example:-

.. code-block:: pyml

    x_scale: linear


.. _grph-x-output-graphs-x-wres-vs-x-grph-x-y-axis-label-list-x-spec:

y_axis_label_list
-----------------

Type: :term:`list(str) <list>`

List of labels for y variables that appear on axes.

Example:-

.. code-block:: pyml

    y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']


.. _grph-x-output-graphs-x-wres-vs-x-grph-x-y-var-src-list-x-spec:

y_var_src_list
--------------

Type: :term:`list(str) <list>`

Names of the solution folders that contain the predictions to be plotted

Example:-

.. code-block:: pyml

    y_var_src_list: ['observed_data', 'final_fit_ppred', 'final_fit_ipred']


.. _grph-x-output-graphs-x-wres-vs-x-grph-x-y-var-list-x-spec:

y_var_list
----------

Type: :term:`list(str) <list>`

List of y variable names (i.e. columns in the predictions table) to be plotted on graph.

Example:-

.. code-block:: pyml

    y_var_list: ['DV_CENTRAL', 'DV_CENTRAL', 'DV_CENTRAL']


.. _grph-x-output-graphs-x-wres-vs-x-grph-x-y-var-label-list-x-spec:

y_var_label_list
----------------

Type: :term:`list(str) <list>`

List of y variable labels which will appear in the legend as <y_var_label> (<y_var_src>).

Example:-

.. code-block:: pyml

    y_var_label_list: ['Drug conc. (units)', 'Drug conc. (units)', 'Drug conc. (units)']


.. _grph-x-output-graphs-x-wres-vs-x-grph-x-y-var-colour-list-x-spec:

y_var_colour_list
-----------------

Type: :term:`list(str) <list>`

List of colours for y variable plot lines.

Example:-

.. code-block:: pyml

    y_var_colour_list: ['b', 'g']


.. _grph-x-output-graphs-x-wres-vs-x-grph-x-y-var-symbol-list-x-spec:

y_var_symbol_list
-----------------

Type: :term:`list(str) <list>`

List of plot line styles for y variable plot lines.

Example:-

.. code-block:: pyml

    y_var_symbol_list: ['-', '-']


.. _grph-x-output-graphs-x-wres-vs-x-grph-x-y-scale-list-x-spec:

y_scale_list
------------

Type: :term:`list(str) <list>`

List of scales (linear or log) for multiple y axes.

Example:-

.. code-block:: pyml

    y_scale_list: ['linear', 'log']


.. _grph-x-output-graphs-x-wres-vs-x-grph-x-options-list-x-spec:

options_list
------------

Type: :term:`list_of(legend,legend_above,grid,dose_lines,share_axes,sim_xy,square,45degree_line,linreg_line,gaussreg_line) <list_of>`

List of visual options to apply to individual plots.

Example:-

.. code-block:: pyml

    options_list: ['legend', 'grid', 'dose_lines']


.. _grph-x-output-graphs-x-wres-vs-x-grph-x-dot-size-x-spec:

dot_size
--------

Type: :term:`int <int>`

Size of dots appearing in scatter plots

Example:-

.. code-block:: pyml

    dot_size: 12


.. _grph-x-output-graphs-x-cwres-vs-x-grph-x-spec:

CWRES_VS_X_GRPH
===============

Type: :term:`dict_record <dict_record>`

Scatter plot for all individuals on a single graph.

Example:-

.. code-block:: pyml

    CWRES_VS_X_GRPH:
        output_subdir: none
        graph_title: My rather excellent graph
        x_axis_label: TIME
        x_var_src: observed_data
        x_var: TIME
        x_scale: linear
        y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']
        y_var_src_list: ['observed_data', 'final_fit_ppred', 'final_fit_ipred']
        y_var_list: ['DV_CENTRAL', 'DV_CENTRAL', 'DV_CENTRAL']
        y_var_label_list: ['Drug conc. (units)', 'Drug conc. (units)', 'Drug conc. (units)']
        y_var_colour_list: ['b', 'g']
        y_var_symbol_list: ['-', '-']
        y_scale_list: ['linear', 'log']
        options_list: ['legend', 'grid', 'dose_lines']
        dot_size: 12


.. _grph-x-output-graphs-x-cwres-vs-x-grph-x-output-subdir-x-spec:

output_subdir
-------------

Type: :term:`output_folder <output_folder>`

Destination subdirectory for these plots.

Example:-

.. code-block:: pyml

    output_subdir: none


.. _grph-x-output-graphs-x-cwres-vs-x-grph-x-graph-title-x-spec:

graph_title
-----------

Type: :term:`str <str>`

Title of graph.

Example:-

.. code-block:: pyml

    graph_title: My rather excellent graph


.. _grph-x-output-graphs-x-cwres-vs-x-grph-x-x-axis-label-x-spec:

x_axis_label
------------

Type: :term:`str <str>`

x axis label text

Example:-

.. code-block:: pyml

    x_axis_label: TIME


.. _grph-x-output-graphs-x-cwres-vs-x-grph-x-x-var-src-x-spec:

x_var_src
---------

Type: :term:`str <str>`

Name of the folder containing the solution.pyml and predictions.csv for the data on the x-axis.

Example:-

.. code-block:: pyml

    x_var_src: observed_data


.. _grph-x-output-graphs-x-cwres-vs-x-grph-x-x-var-x-spec:

x_var
-----

Type: :term:`str <str>`

x axis variable name.

Example:-

.. code-block:: pyml

    x_var: TIME


.. _grph-x-output-graphs-x-cwres-vs-x-grph-x-x-scale-x-spec:

x_scale
-------

Type: :term:`one_of(linear,log) <one_of>`

x axis scale - can be either 'linear' or 'log'.

Example:-

.. code-block:: pyml

    x_scale: linear


.. _grph-x-output-graphs-x-cwres-vs-x-grph-x-y-axis-label-list-x-spec:

y_axis_label_list
-----------------

Type: :term:`list(str) <list>`

List of labels for y variables that appear on axes.

Example:-

.. code-block:: pyml

    y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']


.. _grph-x-output-graphs-x-cwres-vs-x-grph-x-y-var-src-list-x-spec:

y_var_src_list
--------------

Type: :term:`list(str) <list>`

Names of the solution folders that contain the predictions to be plotted

Example:-

.. code-block:: pyml

    y_var_src_list: ['observed_data', 'final_fit_ppred', 'final_fit_ipred']


.. _grph-x-output-graphs-x-cwres-vs-x-grph-x-y-var-list-x-spec:

y_var_list
----------

Type: :term:`list(str) <list>`

List of y variable names (i.e. columns in the predictions table) to be plotted on graph.

Example:-

.. code-block:: pyml

    y_var_list: ['DV_CENTRAL', 'DV_CENTRAL', 'DV_CENTRAL']


.. _grph-x-output-graphs-x-cwres-vs-x-grph-x-y-var-label-list-x-spec:

y_var_label_list
----------------

Type: :term:`list(str) <list>`

List of y variable labels which will appear in the legend as <y_var_label> (<y_var_src>).

Example:-

.. code-block:: pyml

    y_var_label_list: ['Drug conc. (units)', 'Drug conc. (units)', 'Drug conc. (units)']


.. _grph-x-output-graphs-x-cwres-vs-x-grph-x-y-var-colour-list-x-spec:

y_var_colour_list
-----------------

Type: :term:`list(str) <list>`

List of colours for y variable plot lines.

Example:-

.. code-block:: pyml

    y_var_colour_list: ['b', 'g']


.. _grph-x-output-graphs-x-cwres-vs-x-grph-x-y-var-symbol-list-x-spec:

y_var_symbol_list
-----------------

Type: :term:`list(str) <list>`

List of plot line styles for y variable plot lines.

Example:-

.. code-block:: pyml

    y_var_symbol_list: ['-', '-']


.. _grph-x-output-graphs-x-cwres-vs-x-grph-x-y-scale-list-x-spec:

y_scale_list
------------

Type: :term:`list(str) <list>`

List of scales (linear or log) for multiple y axes.

Example:-

.. code-block:: pyml

    y_scale_list: ['linear', 'log']


.. _grph-x-output-graphs-x-cwres-vs-x-grph-x-options-list-x-spec:

options_list
------------

Type: :term:`list_of(legend,legend_above,grid,dose_lines,share_axes,sim_xy,square,45degree_line,linreg_line,gaussreg_line) <list_of>`

List of visual options to apply to individual plots.

Example:-

.. code-block:: pyml

    options_list: ['legend', 'grid', 'dose_lines']


.. _grph-x-output-graphs-x-cwres-vs-x-grph-x-dot-size-x-spec:

dot_size
--------

Type: :term:`int <int>`

Size of dots appearing in scatter plots

Example:-

.. code-block:: pyml

    dot_size: 12


.. _grph-x-output-graphs-x-spag-grph-x-spec:

SPAG_GRPH
=========

Type: :term:`dict_record <dict_record>`

Plot data for all individuals on separate graphs.

Example:-

.. code-block:: pyml

    SPAG_GRPH:
        output_subdir: none
        graph_title: My rather excellent graph
        x_axis_label: TIME
        x_var: TIME
        x_scale: linear
        y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']
        y_var_src_list: ['observed_data', 'final_fit_ppred', 'final_fit_ipred']
        y_var_list: ['DV_CENTRAL', 'DV_CENTRAL', 'DV_CENTRAL']
        y_var_label_list: ['Drug conc. (units)', 'Drug conc. (units)', 'Drug conc. (units)']
        y_var_colour_list: ['b', 'g']
        y_var_symbol_list: ['-', '-']
        y_scale_list: ['linear', 'log']
        options_list: ['legend', 'grid', 'dose_lines']


.. _grph-x-output-graphs-x-spag-grph-x-output-subdir-x-spec:

output_subdir
-------------

Type: :term:`output_folder <output_folder>`

Destination subdirectory for these plots.

Example:-

.. code-block:: pyml

    output_subdir: none


.. _grph-x-output-graphs-x-spag-grph-x-graph-title-x-spec:

graph_title
-----------

Type: :term:`str <str>`

Title of graph.

Example:-

.. code-block:: pyml

    graph_title: My rather excellent graph


.. _grph-x-output-graphs-x-spag-grph-x-x-axis-label-x-spec:

x_axis_label
------------

Type: :term:`str <str>`

x axis label text

Example:-

.. code-block:: pyml

    x_axis_label: TIME


.. _grph-x-output-graphs-x-spag-grph-x-x-var-x-spec:

x_var
-----

Type: :term:`str <str>`

x axis variable name.

Example:-

.. code-block:: pyml

    x_var: TIME


.. _grph-x-output-graphs-x-spag-grph-x-x-scale-x-spec:

x_scale
-------

Type: :term:`one_of(linear,log) <one_of>`

x axis scale - can be either 'linear' or 'log'.

Example:-

.. code-block:: pyml

    x_scale: linear


.. _grph-x-output-graphs-x-spag-grph-x-y-axis-label-list-x-spec:

y_axis_label_list
-----------------

Type: :term:`list(str) <list>`

List of labels for y variables that appear on axes.

Example:-

.. code-block:: pyml

    y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']


.. _grph-x-output-graphs-x-spag-grph-x-y-var-src-list-x-spec:

y_var_src_list
--------------

Type: :term:`list(str) <list>`

Names of the solution folders that contain the predictions to be plotted

Example:-

.. code-block:: pyml

    y_var_src_list: ['observed_data', 'final_fit_ppred', 'final_fit_ipred']


.. _grph-x-output-graphs-x-spag-grph-x-y-var-list-x-spec:

y_var_list
----------

Type: :term:`list(str) <list>`

List of y variable names (i.e. columns in the predictions table) to be plotted on graph.

Example:-

.. code-block:: pyml

    y_var_list: ['DV_CENTRAL', 'DV_CENTRAL', 'DV_CENTRAL']


.. _grph-x-output-graphs-x-spag-grph-x-y-var-label-list-x-spec:

y_var_label_list
----------------

Type: :term:`list(str) <list>`

List of y variable labels which will appear in the legend as <y_var_label> (<y_var_src>).

Example:-

.. code-block:: pyml

    y_var_label_list: ['Drug conc. (units)', 'Drug conc. (units)', 'Drug conc. (units)']


.. _grph-x-output-graphs-x-spag-grph-x-y-var-colour-list-x-spec:

y_var_colour_list
-----------------

Type: :term:`list(str) <list>`

List of colours for y variable plot lines.

Example:-

.. code-block:: pyml

    y_var_colour_list: ['b', 'g']


.. _grph-x-output-graphs-x-spag-grph-x-y-var-symbol-list-x-spec:

y_var_symbol_list
-----------------

Type: :term:`list(str) <list>`

List of plot line styles for y variable plot lines.

Example:-

.. code-block:: pyml

    y_var_symbol_list: ['-', '-']


.. _grph-x-output-graphs-x-spag-grph-x-y-scale-list-x-spec:

y_scale_list
------------

Type: :term:`list(str) <list>`

List of scales (linear or log) for multiple y axes.

Example:-

.. code-block:: pyml

    y_scale_list: ['linear', 'log']


.. _grph-x-output-graphs-x-spag-grph-x-options-list-x-spec:

options_list
------------

Type: :term:`list_of(legend,legend_above,grid,dose_lines,share_axes,sim_xy,square,45degree_line,linreg_line,gaussreg_line) <list_of>`

List of visual options to apply to individual plots.

Example:-

.. code-block:: pyml

    options_list: ['legend', 'grid', 'dose_lines']



