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

Population plots and tables: Time profiles and Residuals #18

Closed
Yuri05 opened this issue Nov 27, 2019 · 1 comment
Closed

Population plots and tables: Time profiles and Residuals #18

Yuri05 opened this issue Nov 27, 2019 · 1 comment

Comments

@Yuri05
Copy link
Member

Yuri05 commented Nov 27, 2019

Inputs

  • Output folder of the Simulate population task (with calculated simulation results)
  • Output Folder for results (all results will be generated here)
  • OPTIONAL Number of Cores
  • Type. One of:
    • Pediatric: one population may be marked as (adult) reference
    • Parallel comparison: no population is marked as special.
    • Ratio comparison:
      • special case for analysis of one property of a population (e.g. GFR)
      • one population (e.g. "healthy") is marked as reference
      • for all other (e.g. "diseased") populations: ratios of all PK Parameters to the corresponding healthy one is calculated and plotted as Box-Whisker plot
  • 1 or more populations
  • List of datasets
  • Settings (s. also getDefaultTimeProfileAndResidualSettings #13):
    • Reference population ( may be empty)
      • OPTIONAL Time offset
    • display Unit for time. Default: h
    • List of time Time ranges. One plot per time range
      • Single dose: Default total range
      • For multiple dose additionally: first and last application
    • scale of y axes (lin/log/both). Default: both
    • Aggregation type for Residuals. One of {Mean, Geomean, Median}. Default: Median
    • Types of Plot. Default: all 6 plot types. For each plot: plot per pop or for all pops or both
      1. Simulated time profile: Mean, Median and 5th - 95th percentile range of the simulated time profiles (if available with data). If a reference population is defined, it is also plotted.
      2. Residuals (based on population mean or geomean or median (depending on the aggregation type) ) vs time
      3. Residuals (based on population mean or geomean or median (depending on the aggregation type) ) vs simulated output
      4. Predicted (population mean or geomean or median (depending on the aggregation type)) vs observed
      5. Histogram of residuals (For all outputs together)
      6. qq-plot of residuals (For all outputs together)

Outputs

In the output folder: all plots/tables as specified in the settings

  • one subsection for each population, reference population is plotted in each population as reference
  • (for all plot types except for time profiles) if specified in the settings: one section for merged plots (= all pops in one plot)
  • Tables: currently NONE
@Yuri05 Yuri05 added this to the Milestone 1 (OSP Suite 9) milestone Nov 27, 2019
@Yuri05 Yuri05 changed the title Population plots: Time profiles and Residuals Population plots and tables: Time profiles and Residuals Nov 27, 2019
@sfrechen
Copy link
Member

Please note:

Simulated time profile: Mean, Median and 5th - 95th percentile range of the simulated time profiles (if available with data). If a reference population is defined, it is also plotted (if available with data).

pchelle added a commit to pchelle/OSPSuite.ReportingEngine that referenced this issue Apr 23, 2020
…ime profile and residuals

The legend caption is currently not that great.
The next version of tlf will improve that greatly
pchelle added a commit to pchelle/OSPSuite.ReportingEngine that referenced this issue Apr 27, 2020
…ime profile and residuals

The legend caption is currently not that great.
The next version of tlf will improve that greatly
msevestre pushed a commit that referenced this issue Apr 30, 2020
* Fixes #18 add alpha version for population time profile and residuals

The legend caption is currently not that great.
The next version of tlf will improve that greatly

* Move print method to parent class workflow

* Fix crash when no display unit is requested

* Introduce PopulationWorklfowTypes

Option from enum to handle the 3 types of pop workflows

* Introduce PopulationPlotTask

Specific kind of plot task that will get results from all the population-simulations as a whole

* Add referencePopulation field to PopulationSimulationSet

* Introduce plotPopulationPKparameters

WIP: 
@Yuri05 I wanted to include ratio and x, but was not sure of what the features are exactly. Between which population or parameters do we need to calculate the ratio ? Same for x, is a VPC the plot output when x is input ?

* Assign plotPopulationPKparameters to taskFunction

Also set the active default for all the tasks but simulate to FALSE

* Warning message for no reference in a workflow type pediatric or ratio

* Update documentation

* Introduce task options xParameters and yParameters

demography and population pk parameter plots have the option to create vpc like plots of yParameters in function of xParameters.
The goal is to use this task option to select which parameters to plot

* Include ratio boxplots within plotPopulationPKParameters

To be performed only if workflowType is ratio comparison

* Fix population plot task export tables associated to a plot name

* Fix nomenclature of enum DemographyPaths

* Introduce range plot for parameter vpcs

* Fix aggregation method in calculation of vpc values

* Update documentation

* Remove DemograthyPaths

User will have to use ospsuite to get them

* Simplify chunks of plot pk parameters

* Provide test examples fro population workflows

* Fixes #153 Introduce method to set plot format

* Fix loadSimulationWithUpdatedPaths if no path is input

* Update documentation

* Fixes #153 integrate settings of plot format and an example
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants