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

23 r re #24

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft

23 r re #24

wants to merge 6 commits into from

Conversation

Yuri05
Copy link
Member

@Yuri05 Yuri05 commented Aug 29, 2022

No description provided.

@Yuri05 Yuri05 marked this pull request as draft August 29, 2022 15:01
@@ -1,2 +1,2 @@
Simulated versus observed concentration-time profiles of all data listed in [Section 2.2.2](#222-clinical-data) are presented below.
Simulated versus observed concentration-time profiles of all data listed in [Section 2.2.2](#clinical-data) are presented below.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use section reference (defined in the qualification plan) instead of the url generated from the title

@@ -2,7 +2,7 @@

**Baneyx 2014** Baneyx, G., Parrott, N., Meille, C., Iliadis, A. & Lavé, T. Physiologically based pharmacokinetic modeling of CYP3A4 induction by rifampicin in human: influence of time between substrate and inducer administration. Eur. J. Pharm. Sci. 56, 1–15 (2014).

**DrugBank DB00802** https://www.drugbank.ca/drugs/DB00802, accessed 05-15-2020.
**DrugBank DB00802** [https://www.drugbank.ca/drugs/DB00802](https://www.drugbank.ca/drugs/DB00802), accessed 05-15-2020.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Always better to use the markdown link formatting instead of putting the url directly in text
(e.g. when just putting as text: the hyperlink is not created in word/pdf report and not properly checked by some url checkers)

@@ -1,34 +1,34 @@
### 2.2.1 In vitro / physicochemical Data
### In vitro / physicochemical Data
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Chapter numbers must be removed in the static content files as well!

@@ -14,4 +14,4 @@

This evaluation report and the corresponding PK-Sim project file are filed at:

https://github.com/Open-Systems-Pharmacology/OSP-PBPK-Model-Library/
[https://github.com/Open-Systems-Pharmacology/OSP-PBPK-Model-Library/](https://github.com/Open-Systems-Pharmacology/OSP-PBPK-Model-Library/)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above: using hyperlinks in md-format ([text](url)) should always be used instead of just url

@@ -1,5 +1,5 @@
{
"$schema": "https://github.com/Open-Systems-Pharmacology/QualificationPlan/releases/download/v2.1/OSP_Qualification_Plan_Schema.json",
"$schema": "https://github.com/Open-Systems-Pharmacology/QualificationPlan/releases/download/v3.0/OSP_Qualification_Plan_Schema.json",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

switch to the new schema

@@ -123,74 +123,77 @@
{
"Project": "Alfentanil",
"Simulation": "Ferrier 1985, Alfentanil iv 0.05 mg/kg",
"SectionId": 331
"SectionReference": "ct-profiles-model-building"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use section reference instead of section id everywhere

"PlotTypes": [
"predictedVsObserved",
"residualsOverTime"
],
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use PlotTypes (array) instead of PlotType (string).

"Kharasch 2011b - Alfentanil IV Control simultaneous - Alfentanil - IV - 1 mg - Plasma - agg. (n=6)",
"Kharasch 2011b - Alfentanil IV Grapefruit coadmin sequential - Alfentanil - IV - 1 mg - Plasma - agg. (n=6)",
"Kharasch 2011b - Alfentanil IV Grapefruit coadmin simultaneous - Alfentanil - IV - 1 mg - Plasma - agg. (n=6)"
],
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use array of observed data instead of duplication.
Can be used only if all other properties (project, simulation, output, color,...) are the same - which was the case here

"Id": 1,
"Title": "1 Introduction",
"Reference": "introduction",
"Title": "Introduction",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Use Reference instead of Id in every section
  • Remove chapter number from the title

"Title": "2 Methods",
"Content": "Content/Section2_Methods.md",
"Reference": "methods",
"Title": "Methods",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no need to refer empty content files anymore. IF the chapter has only subchapters but no content - just remove the "Content" field.

"Id": 5,
"Title": "5 References",
"Reference": "main-references",
"Title": "References",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer to define the Reference for this chapter as "main-references" and not just "references" to avoid potential collisions (if other chapters have their own references section)

@@ -0,0 +1,160 @@
#' @title createQualificationReport
Copy link
Member Author

@Yuri05 Yuri05 Aug 29, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

workflow.R here is almost 1:1 copy of the template provided with the ospsuite.reportingengine package.
The only thing I needed to do: replace "qualification_plan.json" with "evaluation_plan.json"

@@ -1,8102 +1,8297 @@
{
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lot of changes here due to the snapshot conversion.
To see the significant changes (consolidation of protein expression profiles) - refer to this commit:
00beb5b

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant