# METHOD_OPTIONS

Type: dict_record

method options for plt_vpc

Example:-

    METHOD_OPTIONS:
        py_module: vpc

## py_module

Type: one_of(vpc)

Python module required to process this script file

Example:-

    py_module: vpc

# FILE_PATHS

Type: dict_record

file paths

Example:-

    FILE_PATHS:
        input_data_file: input.csv
        msim_folder: msol
        pred_file_glob: sim_*_pop.csv
        output_folder: auto
        log_folder: auto
        output_file_ext: ['svg']

## input_data_file

Type: input_file

path to input comma separated value file in popy data format

Example:-

    input_data_file: input.csv

## msim_folder

Type: input_folder

folder containing multi sim populations.

Example:-

    msim_folder: msol

## pred_file_glob

Type: str

File name for predictions object in msim folder Must be a glob.

Example:-

    pred_file_glob: sim_*_pop.csv

## output_folder

Type: output_folder / auto

Output folder - results of computation stored here

Example:-

    output_folder: auto

## log_folder

Type: output_folder / auto

Log folder - log files stored here

Example:-

    log_folder: auto

## output_file_ext

Type: list_of(pdf,png,svg)

Output file extension - determines graphical output file format.

Example:-

    output_file_ext: ['svg']

# DATA_FIELDS

Type: dict_record

data fields for popy.dat.fields object

Example:-

    DATA_FIELDS:
        type_field: TYPE
        id_field: ID
        time_field: TIME

## type_field

Type: str

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

Example:-

    type_field: TYPE

## id_field

Type: str

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

Example:-

    id_field: ID

## time_field

Type: str

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

Example:-

    time_field: TIME

# OUTPUT_GRAPHS

Type: list_record

List of graphs to output.

Example:-

    OUTPUT_GRAPHS:
        - IND_SPAG_VPC:
            graph_title: My rather excellent graph
            y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']
            y_var_src_list: ['orig', 'sim']
            y_var_label_list: ['drug in plasma', 'bio marker in plasma']
            y_var_colour_list: ['b', 'g']
            y_var_symbol_list: ['-', '-']
            x_var: TIME
            x_axis_label: Time (hours)
            x_scale: linear
            y_var_list: ['CONC_DRUG', 'CONC_BIO_MARKER']
            y_scale_list: ['linear', 'log']
            options_list: ['legend', 'grid', 'dose_lines']

        - COMB_SPAG_VPC:
            graph_title: My rather excellent graph
            y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']
            y_var_src_list: ['orig', 'sim']
            y_var_label_list: ['drug in plasma', 'bio marker in plasma']
            y_var_colour_list: ['b', 'g']
            y_var_symbol_list: ['-', '-']
            x_var: TIME
            x_axis_label: Time (hours)
            x_scale: linear
            y_var_list: ['CONC_DRUG', 'CONC_BIO_MARKER']
            y_scale_list: ['linear', 'log']
            options_list: ['legend', 'grid', 'dose_lines']

        - COMB_QUANT_SIM_VPC:
            graph_title: My rather excellent graph
            y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']
            y_var_src_list: ['orig', 'sim']
            y_var_label_list: ['drug in plasma', 'bio marker in plasma']
            y_var_colour_list: ['b', 'g']
            x_var: TIME
            x_axis_label: Time (hours)
            x_scale: linear
            y_var_list: ['CONC_DRUG', 'CONC_BIO_MARKER']
            y_scale_list: ['linear', 'log']
            bin_indexer: {EQUAL_SPACE: {n_bins: auto}}
            quantile_list: [0.05, 0.5, 0.95]
            min_bin_count: 10
            options_list: ['legend_above', 'grid', 'contour_conf_intervals']
            conf_interval_prop: 0.9

        - COMB_QUANT_VPC:
            graph_title: My rather excellent graph
            y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']
            y_var_src_list: ['orig', 'sim']
            y_var_label_list: ['drug in plasma', 'bio marker in plasma']
            y_var_colour_list: ['b', 'g']
            y_var_symbol_list: ['-', '-']
            x_var: TIME
            x_axis_label: Time (hours)
            x_scale: linear
            y_var_list: ['CONC_DRUG', 'CONC_BIO_MARKER']
            y_scale_list: ['linear', 'log']
            options_list: ['legend', 'grid', 'dose_lines']
            bin_indexer: {EQUAL_SPACE: {n_bins: auto}}
            quantile_list: [0.05, 0.5, 0.95]
            min_bin_count: 10

## IND_SPAG_VPC

Type: dict_record

Plot vpc data for each individual on separate graphs.

Example:-

    IND_SPAG_VPC:
        graph_title: My rather excellent graph
        y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']
        y_var_src_list: ['orig', 'sim']
        y_var_label_list: ['drug in plasma', 'bio marker in plasma']
        y_var_colour_list: ['b', 'g']
        y_var_symbol_list: ['-', '-']
        x_var: TIME
        x_axis_label: Time (hours)
        x_scale: linear
        y_var_list: ['CONC_DRUG', 'CONC_BIO_MARKER']
        y_scale_list: ['linear', 'log']
        options_list: ['legend', 'grid', 'dose_lines']

### graph_title

Type: str

Title of graph.

Example:-

    graph_title: My rather excellent graph

### y_axis_label_list

Type: list(str)

List of labels for y variables that appear on axes.

Example:-

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

### y_var_src_list

Type: list(str)

List of y variable types, orig = original data set sim = simulated data

Example:-

    y_var_src_list: ['orig', 'sim']

### y_var_label_list

Type: list(str)

List of y variable labels, which appear in the legend.

Example:-

    y_var_label_list: ['drug in plasma', 'bio marker in plasma']

### y_var_colour_list

Type: list(str)

List of colours for y variable plot lines.

Example:-

    y_var_colour_list: ['b', 'g']

### y_var_symbol_list

Type: list(str)

List of plot line styles for y variable plot lines.

Example:-

    y_var_symbol_list: ['-', '-']

### x_var

Type: str

x axis variable name.

Example:-

    x_var: TIME

### x_axis_label

Type: str

x axis label text.

Example:-

    x_axis_label: Time (hours)

### x_scale

Type: one_of(linear,log)

x axis scale - can be either ‘linear’ or ‘log’.

Example:-

    x_scale: linear

### y_var_list

Type: list(str)

List of y variable names to be plotted on graph.

Example:-

    y_var_list: ['CONC_DRUG', 'CONC_BIO_MARKER']

### y_scale_list

Type: list(str)

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

Example:-

    y_scale_list: ['linear', 'log']

### options_list

Type: list_of(legend,legend_above,grid,dose_lines,share_axes,45degree_line,sim_xy)

List of visual options to apply to individual plots.

Example:-

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

## COMB_SPAG_VPC

Type: dict_record

Plot vpc data for all individuals on one graph.

Example:-

    COMB_SPAG_VPC:
        graph_title: My rather excellent graph
        y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']
        y_var_src_list: ['orig', 'sim']
        y_var_label_list: ['drug in plasma', 'bio marker in plasma']
        y_var_colour_list: ['b', 'g']
        y_var_symbol_list: ['-', '-']
        x_var: TIME
        x_axis_label: Time (hours)
        x_scale: linear
        y_var_list: ['CONC_DRUG', 'CONC_BIO_MARKER']
        y_scale_list: ['linear', 'log']
        options_list: ['legend', 'grid', 'dose_lines']

### graph_title

Type: str

Title of graph.

Example:-

    graph_title: My rather excellent graph

### y_axis_label_list

Type: list(str)

List of labels for y variables that appear on axes.

Example:-

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

### y_var_src_list

Type: list(str)

List of y variable types, orig = original data set sim = simulated data

Example:-

    y_var_src_list: ['orig', 'sim']

### y_var_label_list

Type: list(str)

List of y variable labels, which appear in the legend.

Example:-

    y_var_label_list: ['drug in plasma', 'bio marker in plasma']

### y_var_colour_list

Type: list(str)

List of colours for y variable plot lines.

Example:-

    y_var_colour_list: ['b', 'g']

### y_var_symbol_list

Type: list(str)

List of plot line styles for y variable plot lines.

Example:-

    y_var_symbol_list: ['-', '-']

### x_var

Type: str

x axis variable name.

Example:-

    x_var: TIME

### x_axis_label

Type: str

x axis label text.

Example:-

    x_axis_label: Time (hours)

### x_scale

Type: one_of(linear,log)

x axis scale - can be either ‘linear’ or ‘log’.

Example:-

    x_scale: linear

### y_var_list

Type: list(str)

List of y variable names to be plotted on graph.

Example:-

    y_var_list: ['CONC_DRUG', 'CONC_BIO_MARKER']

### y_scale_list

Type: list(str)

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

Example:-

    y_scale_list: ['linear', 'log']

### options_list

Type: list_of(legend,legend_above,grid,dose_lines,share_axes,45degree_line,sim_xy)

List of visual options to apply to individual plots.

Example:-

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

## COMB_QUANT_SIM_VPC

Type: dict_record

Plot vpc data using histograms of each simulation one graph.

Example:-

    COMB_QUANT_SIM_VPC:
        graph_title: My rather excellent graph
        y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']
        y_var_src_list: ['orig', 'sim']
        y_var_label_list: ['drug in plasma', 'bio marker in plasma']
        y_var_colour_list: ['b', 'g']
        x_var: TIME
        x_axis_label: Time (hours)
        x_scale: linear
        y_var_list: ['CONC_DRUG', 'CONC_BIO_MARKER']
        y_scale_list: ['linear', 'log']
        bin_indexer: {EQUAL_SPACE: {n_bins: auto}}
        quantile_list: [0.05, 0.5, 0.95]
        min_bin_count: 10
        options_list: ['legend_above', 'grid', 'contour_conf_intervals']
        conf_interval_prop: 0.9

### graph_title

Type: str

Title of graph.

Example:-

    graph_title: My rather excellent graph

### y_axis_label_list

Type: list(str)

List of labels for y variables that appear on axes.

Example:-

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

### y_var_src_list

Type: list(str)

List of y variable types, orig = original data set sim = simulated data

Example:-

    y_var_src_list: ['orig', 'sim']

### y_var_label_list

Type: list(str)

List of y variable labels, which appear in the legend.

Example:-

    y_var_label_list: ['drug in plasma', 'bio marker in plasma']

### y_var_colour_list

Type: list(str)

List of colours for y variable plot lines.

Example:-

    y_var_colour_list: ['b', 'g']

### x_var

Type: str

x axis variable name.

Example:-

    x_var: TIME

### x_axis_label

Type: str

x axis label text.

Example:-

    x_axis_label: Time (hours)

### x_scale

Type: one_of(linear,log)

x axis scale - can be either ‘linear’ or ‘log’.

Example:-

    x_scale: linear

### y_var_list

Type: list(str)

List of y variable names to be plotted on graph.

Example:-

    y_var_list: ['CONC_DRUG', 'CONC_BIO_MARKER']

### y_scale_list

Type: list(str)

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

Example:-

    y_scale_list: ['linear', 'log']

### bin_indexer

Type: one_of_record

Possible bin indexing methods.

Example:-

    bin_indexer:
        EQUAL_SPACE: {n_bins: auto}

#### EQUAL_SPACE

Type: dict_record

Equally spaced index builder.

Example:-

    EQUAL_SPACE:
        n_bins: auto

##### n_bins

Type: int / auto

Number of equally spaced bins in index.

Example:-

    n_bins: auto

#### UNEQUAL_SPACE

Type: dict_record

fixed, irregularly spaced user defined bin edges.

Example:-

    UNEQUAL_SPACE:
        bin_edge_list: [2.0, 4.0, 8.0]

##### bin_edge_list

Type: list(float)

List of user-defined bin edges.

Example:-

    bin_edge_list: [2.0, 4.0, 8.0]

#### K_MEANS

Type: dict_record

Deduce bin centres automatically using k-means algorithm for a pre-determined number of bins.

Example:-

    K_MEANS:
        n_bins: 10
        init_method: random

##### n_bins

Type: int

Number of bins.

Example:-

    n_bins: 10

##### init_method

Type: one_of(random)

Initialisation method for k-means algorithm.

Example:-

    init_method: random

### quantile_list

Type: list(float)

List of quantiles to plot for each bin of the histogram.

Example:-

    quantile_list: [0.05, 0.5, 0.95]

### min_bin_count

Type: int

Number of data points required to plot an individual bin.

Example:-

    min_bin_count: 10

### options_list

Type: list_of(legend,legend_above,grid,contour_conf_intervals)

List of visual options to apply to individual plots.

Example:-

    options_list: ['legend_above', 'grid', 'contour_conf_intervals']

### conf_interval_prop

Type: float

Confidence interval proportion to display for each quantile.

Example:-

    conf_interval_prop: 0.9

## COMB_QUANT_VPC

Type: dict_record

Plot vpc data using histograms on one graph.

Example:-

    COMB_QUANT_VPC:
        graph_title: My rather excellent graph
        y_axis_label_list: ['Drug concentration in plasma', 'Bio-marker concentration in plasma']
        y_var_src_list: ['orig', 'sim']
        y_var_label_list: ['drug in plasma', 'bio marker in plasma']
        y_var_colour_list: ['b', 'g']
        y_var_symbol_list: ['-', '-']
        x_var: TIME
        x_axis_label: Time (hours)
        x_scale: linear
        y_var_list: ['CONC_DRUG', 'CONC_BIO_MARKER']
        y_scale_list: ['linear', 'log']
        options_list: ['legend', 'grid', 'dose_lines']
        bin_indexer: {EQUAL_SPACE: {n_bins: auto}}
        quantile_list: [0.05, 0.5, 0.95]
        min_bin_count: 10

### graph_title

Type: str

Title of graph.

Example:-

    graph_title: My rather excellent graph

### y_axis_label_list

Type: list(str)

List of labels for y variables that appear on axes.

Example:-

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

### y_var_src_list

Type: list(str)

List of y variable types, orig = original data set sim = simulated data

Example:-

    y_var_src_list: ['orig', 'sim']

### y_var_label_list

Type: list(str)

List of y variable labels, which appear in the legend.

Example:-

    y_var_label_list: ['drug in plasma', 'bio marker in plasma']

### y_var_colour_list

Type: list(str)

List of colours for y variable plot lines.

Example:-

    y_var_colour_list: ['b', 'g']

### y_var_symbol_list

Type: list(str)

List of plot line styles for y variable plot lines.

Example:-

    y_var_symbol_list: ['-', '-']

### x_var

Type: str

x axis variable name.

Example:-

    x_var: TIME

### x_axis_label

Type: str

x axis label text.

Example:-

    x_axis_label: Time (hours)

### x_scale

Type: one_of(linear,log)

x axis scale - can be either ‘linear’ or ‘log’.

Example:-

    x_scale: linear

### y_var_list

Type: list(str)

List of y variable names to be plotted on graph.

Example:-

    y_var_list: ['CONC_DRUG', 'CONC_BIO_MARKER']

### y_scale_list

Type: list(str)

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

Example:-

    y_scale_list: ['linear', 'log']

### options_list

Type: list_of(legend,legend_above,grid,dose_lines,share_axes,45degree_line,sim_xy)

List of visual options to apply to individual plots.

Example:-

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

### bin_indexer

Type: one_of_record

Possible bin indexing methods.

Example:-

    bin_indexer:
        EQUAL_SPACE: {n_bins: auto}

#### EQUAL_SPACE

Type: dict_record

Equally spaced index builder.

Example:-

    EQUAL_SPACE:
        n_bins: auto

##### n_bins

Type: int / auto

Number of equally spaced bins in index.

Example:-

    n_bins: auto

#### UNEQUAL_SPACE

Type: dict_record

fixed, irregularly spaced user defined bin edges.

Example:-

    UNEQUAL_SPACE:
        bin_edge_list: [2.0, 4.0, 8.0]

##### bin_edge_list

Type: list(float)

List of user-defined bin edges.

Example:-

    bin_edge_list: [2.0, 4.0, 8.0]

#### K_MEANS

Type: dict_record

Deduce bin centres automatically using k-means algorithm for a pre-determined number of bins.

Example:-

    K_MEANS:
        n_bins: 10
        init_method: random

##### n_bins

Type: int

Number of bins.

Example:-

    n_bins: 10

##### init_method

Type: one_of(random)

Initialisation method for k-means algorithm.

Example:-

    init_method: random

### quantile_list

Type: list(float)

List of quantiles to plot for each bin of the histogram.

Example:-

    quantile_list: [0.05, 0.5, 0.95]

### min_bin_count

Type: int

Number of data points required to plot an individual bin.

Example:-

    min_bin_count: 10