List of table placeholder settings

The following page describes all the settings that can be used in table placeholders in reporting templates. Placeholders for tables can include four different groups of settings. These are:

• “data” (required) – containing settings about table content, such as type of the table, and rows and columns that the table will contain,
• “display” (optional) – containing information about table display (e.g., number of significant digits to which the values in the table should be rounded, table direction, style, …
• “stratification” (optional) – containing information about table splitting and/or filtering,
• “renamings” (optional) – containing various words present in the data set or PKanalix that should be reworded in the table.

Settings inside these groups of settings need to be indented or put inside curly brackets. It is crucial to respect the indentation rules and the space after the “:” for the placeholder to be properly interpreted.

Data

Data settings define the type of the table that will be generated, as well as rows and columns that the table will contain. Here is the list of all settings of the data group of settings, along with their descriptions:

Data

Data settings define the type of the table that will be generated, as well as rows and columns that the table will contain. Here is the list of all settings of the data group of settings, along with their descriptions:

Display

Display group of settings defines how the information in the tables will be displayed. Here is the list of all settings for the display group of settings:

Stratification

Stratification group of settings defines how the table will be split. List of stratification settings:

Let’s take a look at the demo project project_crossover_bioequivalence.pkx. It contains data from a 2×2 crossover bioequivalence study of two controlled release formulations of theophylline. We would like to generate a placeholder for the summary table of NCA parameters and split it across sequences and formulations. If we select that we only want to compute Cmax and AUClast, here is how a default placeholder looks like when we click on the placeholder button next to the NCA summary table and which table it produces:

<lixoftPLH>
data:
    task: nca
    metrics: [min, Q1, median, Q3, max, mean, SD, SE, CV, Ntot, Nobs, Nmiss, geoMean, geoSD, geoCV, harmMean]
    parameters: [AUClast, Cmax]
display:
    units: true
    inlineUnits: true
    metricsDirection: horizontal
    significantDigits: 4
    fitToContent: true
</lixoftPLH>

If we want to split the table by the period and the formulation, we can select the appropriate checkboxes on the right and the default placeholder will change automatically. However, doing this always splits the table vertically. We can also remove some of the statistics that we want to exclude from the table by modifying the metrics argument.

<lixoftPLH>
data:
    task: nca
    metrics: [min, median, max, mean, CV, Nobs, geoMean, geoCV]
    parameters: [AUClast, Cmax]
display:
    units: true
    inlineUnits: true
    metricsDirection: horizontal
    significantDigits: 4
    fitToContent: true
stratification:
    state: {split: [FORM, Period]}
    splitDirection: [v, v]
</lixoftPLH>

If we want to change the direction of splitting, for example, make a split by Period horizontal, instead of vertical, we can modify the splitDirection argument.

<lixoftPLH>
data:
    task: nca
    metrics: [Nobs, mean, CV, geoMean, geoCV]
    parameters: [AUClast, Cmax]
display:
    units: true
    inlineUnits: true
    metricsDirection: horizontal
    significantDigits: 4
    fitToContent: true
stratification:
    state: {split: [FORM, Period]}
    splitDirection: [v, h]
</lixoftPLH>

Renamings

Renamings setting can be provided to the placeholder to replace certain words or expressions that will appear in the table with a user-defined word or expression. We will explain the usage of renamings setting on a concrete example.

Let’s take a look at the demo project project_parallel_absBioavailability.pkx. The project contains data from 18 subjects, of which 9 received an IV formulation of a certain drug and other 9 received an oral formulation. Let’s say we want to use the Bioequivalence feature of PKanalix to calculate bioavailability of the oral formulation and generate a report. It would be suitable to put a bioequivalence confidence intervals table in the report, with certain renamings.

A generated placeholder for a BE confidence intervals table, with its default settings, is shown below, including the table it generates.

<lixoftPLH>
data:
    task: be
    table: confidenceIntervals
    metrics: [AdjustedMean, N, Difference, CIRawLower, CIRawUpper, Ratio, CILower, CIUpper, BE]
    parameters: [AUCINF_obs]
display:
    units: true
    inlineUnits: true
    significantDigits: 4
    fitToContent: true
</lixoftPLH>

ORAL

Let’s say we would like to hide some of the columns and rename some of the expressions in the table. For example, it would be convient to rename “Bioequivalence” to “Absolute bioavailability”, “IV” to “intravenous”, “ORAL” to “oral formulation”, and “CILower” to “90% CI (lower)”. We can then modify the placeholder to look like the one on the left and it will generate the table on the right.

<lixoftPLH>
data:
    task: be
    table: confidenceIntervals
    metrics: [AdjustedMean, N, Ratio, CILower, CIUpper]
    parameters: [AUCINF_obs]
renamings: 
    IV: "intravenous"
    ORAL: "oral formulation"
    Bioequivalence: "Absolute bioavailability"
    CILower: "90% CI (lower)"
    CIUpper: "90% CI (upper)"
    AdjustedMean: "Adjusted mean"
</lixoftPLH>

Oral capsule