Open-Systems-Pharmacology / TLF-Library

TLF Library implementation in R
https://www.open-systems-pharmacology.org/TLF-Library/
Other
9 stars 6 forks source link

Figure for reporting engine: histogram #20

Open KatrinCoboeken opened 5 years ago

KatrinCoboeken commented 5 years ago

Figure: histogram

Figure is used to compare the distribution of simulated pk Parameter or physiologic properties vs different virtual populations.

Additional it provides a table which contains the simulated properties in numeric format

Arguments:

Data

· Simulation result of one or more populations

Data.frame/data.table with following columns

o Value (double) value of the output to show (e.g. a PK parameter or a physiological property) in the unit of display, so no unit conversion is needed

o Individual_ID (Integer) must be unique per group

o Group (ordered factor) (character)

it is used to group individual results,

it is also used for legend (e.g. “Pediatric population”,”Adult Population”)

order of factor is used for order on X-Axis

· simulationResult.Metadata metada of Simulation Result

List with following entries:

o Value_unit: character

FigureConfiguration:

· Ystatistic: character (‘count’ or ‘percentage’)

· Xlabel (e.g. ‘Cmax’)

· Xscale: character (default ‘lin’)

· Xlim vector of length 2 (e.g c(0,24)), default NULL time range to display, if null range is calculated to cover whole range of simulated results and observed data

· colorscale_groups (default NULL, then take R defaults) defines colors for different groups

Return:

List with entries

· Figure: Figure object

· Table: table object

Details:

Plotting of simulated results

· Create one histogram for each group all in one plot

· Y axis should be either absolute counts or percentages as defined by argument Ystatistic

· Set color by group

Legend should contain

· group name of simulation result

Xlabel

· according to Xlabel and Ylabel issue #27 Figure: plot time profile

Table construction

Construct data.frame with one row per bin and following columns for each group

· left binborder

· right binborder

for each group

· number of entries per bin

· percentage

Set meaningful column names out of X and Y labels and legend entries

ju-rgen commented 5 years ago

Examples grafik grafik grafik

In Figure configuration should be selectable,

A label for y-axis seems to be necessary, too.