Download and installation
S. the Installation section below.
Documentation
- Reporting Engine
- Tables, Listings and Figures Library (TLF)
- OSPSuite-R
- OSP Suite R Utils (ospsuite.utils)
New features and improvements
New features
Qualification workflows
MeanModel- and Population-Workflows
- Population workflows can use Monte Carlo sampling to handle ratio comparison (#536) as documented in the article PK Parameters in Population Workflows.
Output
objects can now includecolor
andfill
properties that will be displayed in the corresponding plots (#418, #883)dataSelection
is now available at bothSimulationSet
andOutput
levels (#881)- Excel template is up-to-date with the new features (#882) and documented in the article Excel Template
- Mean and Population workflows can display a title/cover page at the beginning of the report (#854) as documented in article Add a title page to your workflow report
Minor improvements and bug fixes
- In qualification workflows, logging now includes information regarding the configuration plan location (#930)
- By default, plot dimensions are now quadratic (#877)
- Statistics in population workflow time profiles now use geometric mean and sd as default and can be easily updated with enum helper
StatisticsTypes
and functionsetDefaultTimeProfileStatistics()
(#862) - Goodness of fit plots and captions were improved (#418, #863, #865, #867, #871, #874, #875, #878, #884, #886, #887, #888)
- Displayed qualification plots now includes following updates:
- Creation of word reports now includes following updates:
- page breaks at appropriate places (#971)
- figure/table numbering (#967) are now fixed
- default reference word document has been updated (#748, #749, #750 and #754)
- tags for subscript (wrapped by
<sub>...</sub>
) and superscript (wrapped by<sup>...</sup>
) are converted to word (#968) - equations wrapped by
$$...$$
and written in LaTeX format are converted to word - bookmarks are now created from markdown anchors (#923)
- Qualification time profiles use base unit if unit is not defined by user (#867, #991)
Installation
1. Prerequisites
The OSPSuite.ReportingEngine package is compatible with version 3.6.x AND version 4.x.x of R. One of its indirect dependency, 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:
- From CRAN:
- ggplot2 (>= 3.3.0)
- jsonlite
- knitr
- pander
- patchwork
- readxl
- reshape2
- rmarkdown
- styler
- ... (s. Installation instructions for the package ospsuite)
- Must be downloaded manually:
- ospsuite.utils (>= 1.4.0)
- tlf (>= 1.5.0)
- rClr (s. Installation instructions for the package ospsuite)
- ospsuite (>= 11.1)
[OPTIONAL] Install Pandoc (required for generation of reports in MS-Word format):
2. Package installation
Finally, install the OSPSuite.ReportingEngine package: