Skip to content

Version 2.0.191
Compare
Choose a tag to compare
@Yuri05 Yuri05 released this 29 Jul 15:55
· 178 commits to main since this release
v2.0.191
f50345c
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

Download and installation

S. the Installation section below.

Documentation

New features and improvements

New features in the Reporting Engine

  • Qualification workflows are now available
    • Get started: https://www.open-systems-pharmacology.org/OSPSuite.ReportingEngine/articles/qualification-workflow.html
    • A template R script for qualification workflows is available at system.file("extdata", "qualification-workflow-template.R", package = "ospsuite.reportingengine"). Copy this file into your workflow folder, rename to "workflow.R" and follow the instructions in the file.
    • Function adjustTitlePage can be used to personalize the report title page (#755)
    • Configuration plans can be reloaded by the QualificationWorkflow objects to update the report display (#567)
    • DDI subunits option is available (#642)
  • With ospsuite version >=10, simulations can be run in parallel (#526)
  • Workflows account for time offset in simulation sets using the option timeOffset for time profile plots (#313) or through user defined PK parameters for PK parameter plots (#578).
  • The function copyReport can be used to copy markdown/word reports (#814)
  • User can define their own word report template to tune the styles of their (MS-Word) report by setting the wordConversionTemplate property of a Workflow object. The default word template is available at system.file("extdata", "reference.docx", package = "ospsuite.reportingengine"). Copy this file to another location and make required modifications.
Adjusting the word template (Instructions copied from the Pandoc documentation, https://pandoc.org/MANUAL.html)
Open reference.docx in Word, modify the styles as you wish, and save the file. For best results, do not make changes to this file other than modifying the styles used by pandoc:

Paragraph styles:

  • Normal
  • Body Text
  • First Paragraph
  • Compact
  • Title
  • Subtitle
  • Author
  • Date
  • Abstract
  • Bibliography
  • Heading 1
  • Heading 2
  • Heading 3
  • Heading 4
  • Heading 5
  • Heading 6
  • Heading 7
  • Heading 8
  • Heading 9
  • Block Text
  • Footnote Text
  • Definition Term
  • Definition
  • Caption
  • Table Caption
  • Image Caption
  • Figure
  • Captioned Figure
  • TOC Heading

Character styles:

  • Default Paragraph Font
  • Body Text Char
  • Verbatim Char
  • Footnote Reference
  • Hyperlink
  • Section Number

Table style:

  • Table

Minor improvements and bug fixes

  • With tlf version 1.2.0, plots in log scale are better displayed (#603)
  • Too long legend captions are now displayed on multiple lines (#568, #602)
  • Output objects are now cloneable (#542)
  • In population workflows, option for adding reference observed data in time profile plots was created (#540).
  • Confusing observed data terminology improved (nonmem was replaced by dataset) (#534)

New features and improvements in the TLF Library

New features

  • New helper functions and parameters to facilitate usage of plot functions (#301):

    • Function getLinesFromFoldDistance translates fold distance values into lines argument for dataMapping objects.
    • Functions plotDDIRatio, plotPKRatio, plotObsVsPred, plotResVsPred and plotResVsTime include optional parameters such as foldDistance, deltaGuest or smoother.

  • New helper enumerated lists:

    • TagPosition (tag position in a plot grid) (#293)
    • HorizontalJustification (horizontal justifications for plot annotation text) (#293)
    • VerticalJustification (vertical justifications for plot annotation text) (#293)
    • PlotAnnotationTextSize (default text sizes for plot annotations) (#293)
    • TickLabelTransforms (predefined tick labeling) (#304)

Minor improvements and bug fixes

  • PlotGridConfiguration class adds new fields to control the position of the individual plot tags and aesthetic properties of the tag text. (#293)

Installation

Option 1 - install from scratch

The OSPSuite.ReportingEngine package is compatible with version 3.6.x AND version 4.x.x of R. One of its indirect dependencies, rClr needs to be installed specifically for the targeted R version. Please follow the installation instructions below:

OSPSuite.ReportingEngine requires following packages to be installed:

[OPTIONAL] Install Pandoc (required for generation of reports in MS-Word format):

Option 2 - use docker images

Assets 5
Loading