Skip to contents

OSPSuite.ReportingEngine implementation in R

Installation

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:

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

Development tasks

dev_mode

devtools::dev_mode function switches your version of R into “development mode”. This is useful to avoid clobbering the existing versions of CRAN packages that you need for other tasks. Calling dev_mode() again will turn development mode off, and return you to your default library setup.

# This will install the package in the folder C:/Rpackages
devtools::dev_mode(path="C:/Rpackages")

Reload the package

devtools::load_all()

or Ctrl + Shift + L

Add or update script files

.R files defined in tests\dev\ will be removed from the package and can be used to simulate interaction with the package. See scripts.R

Code of conduct

Everyone interacting in the Open Systems Pharmacology community (codebases, issue trackers, chat rooms, mailing lists etc…) is expected to follow the Open Systems Pharmacology code of conduct.

Contribution

We encourage contribution to the Open Systems Pharmacology community. Before getting started please read the contribution guidelines. If you are contributing code, please be familiar with the coding standards.

License

OSPSuite.ReportingEngine Library is released under the GPLv2 License.

All trademarks within this document belong to their legitimate owners.