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

Documentation of demography plots - Demography settings #1097

Closed
AnnikaRPS opened this issue Aug 14, 2023 · 2 comments
Closed

Documentation of demography plots - Demography settings #1097

AnnikaRPS opened this issue Aug 14, 2023 · 2 comments

Comments

@AnnikaRPS
Copy link

In the documentation of the demography plots of the RE 2.2.0 (https://www.open-systems-pharmacology.org/OSPSuite.ReportingEngine/dev/articles/demography.html#demography-settings), the last section describes the "Demography settings". I think it would really help to have some example plots here to understand these settings.

pchelle added a commit to pchelle/OSPSuite.ReportingEngine that referenced this issue Oct 17, 2023
…pen-Systems-Pharmacology#1102

- New vignette example uses actual model and populations
- settings are now illustrated by running the corresponding workflow and displaying its report
pchelle added a commit to pchelle/OSPSuite.ReportingEngine that referenced this issue Oct 17, 2023
Yuri05 pushed a commit that referenced this issue Oct 18, 2023
* Fixes #1088 categorical parameters displayed as boxplots in demography

* Fixes #1095 #1097 #1102

- New vignette example uses actual model and populations
- settings are now illustrated by running the corresponding workflow and displaying its report

* Fix centralization of categorical parameter boxplots

* Fixes #1102 prevent range plot connection between bins with no data

* Fixes #1095 #1102 #1097 Update documentation site

* Add usage of tidyr in description

Aggregation with NA in missing group to fix #1102 relies on tidyr
@pchelle
Copy link
Collaborator

pchelle commented Oct 18, 2023

@AnnikaRPS
The examples were updated with a more appropriate model (Aciclovir) and populations (created using ospsuite::createPopulationCharacteristics()) and some of the bugs you noticed (stairstep not straight) were fixed

Could you review the updated version (same link https://www.open-systems-pharmacology.org/OSPSuite.ReportingEngine/dev/articles/demography.html) and let me know if there a still things not accounted for by the documentation ?

@AnnikaRPS
Copy link
Author

@pchelle
I reviewed the documentation some weeks ago and Juri already added some of the issues. Here is some more feedback for the documentation itself (sorry if you already implemented parts of it - I might have missed the changes then):

In General:

  • I personally would not use a pediatric population as a case ecample for the non-pediatric workflows. I think a diseased population or anything else would be more appropriate.
  • The number of observed children is very low with n=3 which makes expescially the range plots weird. I would suggest to use some more individuals.
    -For boxplots it often says "profile" in the figure caption. I wouöld replace that with "boxes", "Data" or anything else but would use "profile" only for the conc-time-profiles.

Parallel and ratio comparison workflows:

  • I don't understand the "not displayed by displayed" part: (it is in the histogram section)
    image

  • In the range plot section, the bracket around "number 1088" is not close:
    image

  • In the code of the range plot section, the variable "displayedPartameters" is not defined:
    image

  • In many figure captions there are two dots e.g.:
    image

  • In some figure captions there is a dot between "scale" and "shwon" e.g.:
    image

Pediatric workflow:

  • I would include the differentiation in typical age groups (pre-school, infant etc) for the pediatric example and not just one population
    -In histograms for children I would not include the adult reference population ( at least not as a default) since the adult demographics might make the smaller numbers for children unreadable / undistingusheable, and is probably not of interest anyway in many cases.

Demography Settings:

  • There is a "by" missing after "not affected":
    image

  • When you set "dodge" to "FALSE" which setting will then be used?
    image

Hope that helps. Let me know if anything is unclear or if you think something is unreasonable.

pchelle added a commit to pchelle/OSPSuite.ReportingEngine that referenced this issue Nov 30, 2023
New populations such as disease states will be included in later versions
pchelle added a commit to pchelle/OSPSuite.ReportingEngine that referenced this issue Nov 30, 2023
@Yuri05 Yuri05 closed this as completed in 8bf616b Nov 30, 2023
@Yuri05 Yuri05 moved this to Verified in Version 2.1 / 2.2 Aug 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Verified
Development

No branches or pull requests

3 participants