RStudio Addins to Work with OSPSuite Framework • ospsuite.addins

The goal of {ospsuite.addins} is to provide RStudio addins to work with the Open System Pharmacology ecosystem.

Installation 💻

You can install the development version of OSPSuite.Addins from GitHub with:

# install.packages("remotes")
remotes::install_github("Open-Systems-Pharmacology/OSPSuite.Addins")

🛈 Important

Once installed, you may need to restart RStudio to see the functions from {ospsuite.addins} in the Addins list.

Documentation 📖

Quick tutorial videos showing how each addin works are available in the Articles tab.

Sections below provide a quick snapshot of the current addins and their purpose.

[!NOTE] All the functions introduced in the examples below can be access by clicking in the Addins menu in RStudio and select the corresponding item.

Addins for `{ospsuite}` ⭐

View OSP Units

View datatable of OSPSuite Dimensions, Units and Base Units

ospsuite.addins::tableOfUnits()

View PK Parameters

View datatable of OSPSuite PK Parameters

ospsuite.addins::tableOfPKParameters()

OSP Unit Converter

Convert Values in Desired OSPSuite Unit

ospsuite.addins::unitConverter()

View Simulation Tree

View simulation tree and select branches

ospsuite.addins::runSimulationTree()

Insert OSPSuite Template

Insert OSPSuite Template in your R Script

ospsuite.addins::insertOSPSuiteTemplate()

Addins for `{ospsuite.reportingengine}` ⭐

View Report

Open and view your report populated by the Reporting Engine with the appropriate software

ospsuite.addins::viewReport()

Copy Qualification Template

Copy and open the Qualification Template R Script

ospsuite.addins::copyQualificationTemplate()

Additional Addins ⭐

Convert your files to UTF-8

Check and convert your files to UTF-8 encoding

ospsuite.addins::utfCheck()

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.

Please submit new feature ideas 💡 and bug reports 🐛 using the Github issues tab.

License

OSPSuite.Addins Library is released under the GPLv3 License.

All trademarks within this document belong to their legitimate owners.

OSPSuite.Addins