Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Figure for reporting engine: box whisker #21

Closed
KatrinCoboeken opened this issue Jun 7, 2019 · 1 comment
Closed

Figure for reporting engine: box whisker #21

KatrinCoboeken opened this issue Jun 7, 2019 · 1 comment
Labels
molecule A composite plot, made of many primitive plots (atoms)

Comments

@KatrinCoboeken
Copy link
Collaborator

Figure: box whisker

Figure is used to compare 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:

· Ylabel (e.g. ‘Cmax’)

· Yscale: character (default ‘lin’)

· Ylim 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

· Percentile of whiskers (default c(5 95))

Return:

List with entries

· Figure: Figure object

· Table: table object

Details:

Plotting of simulated results

· Plot box whsiker plot for each group,

· percentiles of box are 25th, 50th and 75th percentile

· percentiles of whisker can be set by argument

Xticklabels

· group name of simulation result is on the x axis, for long text rotation is needed

Ylabel

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

Table construction

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

· group name

· number of entries per group

· percentile of lower whisker

· 25th percentile

· 50th percentile

· 75th percentile

· percentile of upper whisker

· arithmetric mean value

· standard deviation

· geometric mean value

· geometric standard deviation

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

@ju-rgen
Copy link
Member

ju-rgen commented Jun 11, 2019

Example
grafik

Checks could be necessary for minimal number of values needed for computation of quantiles.

Individual ID seems not to be used, so not needed for input.

@msevestre msevestre transferred this issue from Open-Systems-Pharmacology/OSPSuite-R Jul 4, 2019
@Yuri05 Yuri05 added molecule A composite plot, made of many primitive plots (atoms) and removed To move to RE for R labels Jul 26, 2019
@msevestre msevestre pinned this issue Nov 7, 2019
pchelle added a commit to pchelle/TLF-Library that referenced this issue Nov 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
molecule A composite plot, made of many primitive plots (atoms)
Projects
None yet
Development

No branches or pull requests

4 participants