OSP-Qualification-Reports

Qualification Reports recreated with every new OSP Release

How to create qualification reports

• Create a new branch from the create-reports branch (for instance, my-reports)
  • Define the appropriate OSP environment and tools by updating tools.csv
  • Define the qualifications by updating qualifications.csv
  • Go to the Github Action: Qualification Reports
    • Click on the button Run workflow
      • Select your branch in the first step (for instance, my-reports)
      • Click on the green button Run workflow

What to do when reports are created

When the qualification reports are created, pull requests are triggered (one pull request for each qualification report) toward the develop branch. The pull requests will allow users to review the updates in the reports and adopt the new version.

Qualifications

The qualifications.csv file indicates which qualification plans should be processed. The header includes the following fields:

• Execute: If TRUE run the qualification. If FALSE, skip the qualification.
• Repository name: Name of GitHub OSP repository from which to get the qualification plan, e.g. Qualification-CKD for https://github.com/Open-Systems-Pharmacology/Qualification-CKD.
• Released version: Tag version of the qualificaion plan repository, e.g. 1.0
• Workflow name: Path of workflow R script that creates the function to run the qualification if not default.

Tip

Leave blank cell if default path, Qualification/workflow.R, is used (this path is case insensitive).

• Folder name: Name of exported folder within OSP-Qualification-Reports repository, e.g. Qualification-CKD for OSP-Qualification-Reports/Qualification-CKD

Tools

The tools.csv file indicates software and software versions to be installed in environment before running the qualifications of the models. If a link is defined in the URL column, the installation will use the software from the link as is instead of searching from the version. Please ensure compatibility between their versions. The following available tools to installed are detailed below:

• ospsuite-R : R package providing the functionality of loading, manipulating, and simulating the simulations created in the Open Systems Pharmacology Software tools PK-Sim and MoBi.
• Reporting Engine: R package providing a framework in R to design and create reports evaluating PBPK models developed in the Open Systems Pharmacology ecosystem.
• RUtils: R package providing utility functions for Open Systems Pharmacology R Packages
• TLF: R package providing an object-oriented framework to create tables and figures, which are used by R packages in the Open Systems Pharmacology ecosystem
• rClr: R package for accessing .NET. This package has been deprecated in favor of {rSharp}.
• rSharp: R package providing access to .NET libraries from R. It allows to create .NET objects, access their fields, and call their methods
• Qualification Runner: Qualification runner in charge of managing a qualification workflow
• Qualification Framework: Enables an automated validation of various scenarios (use-cases) supported by the OSP platform
• PK-Sim: Portable version of the comprehensive software tool for whole-body physiologically based pharmacokinetic modeling