Releases: Open-Systems-Pharmacology/OSPSuite-R
ospsuite 12.1.0
Warning: Simulations saved with this pre-release (and all versions >=12) with saveSimulation()
cannot be opened with MoBi versions >12! Currently, only a non-qualified development version 12 of MoBi is available.
Major Changes
- The package fully supports Linux.
- The package loses dependency
{rClr}
and gains{rSharp}
. - The package does not require a local installation of PK-Sim any more. All required
dependencies are shipped with the package.
ospsuite 12.0.0
Breaking Changes
- Based on the Open Systems Pharmacology Suite v12
- The single argument of the
getBaseUnit()
function is now named
quantityOrDimension
(wasdimension
previously). It can now use objects
of classQuantity
as inputs, to be consistent with thetoBaseUnit()
function.
Major Changes
- The package gains
{openxlsx}
and{lifecyle}
dependencies. - Added a function
getSteadyState()
to calculate steady state values for
simulations. This function is of particular use for models of endogenous
substrates, where changing a parameter value (e.g., the production rate)
will change the steady-state values of the substrate. The steady-state is
considered to be the last values of the molecules amounts and state variable
parameters in the simulation with sufficiently long simulation time, i.e.,
where the rates of the processes do not (significantly) change. The
steady-state is NOT analytically calculated or estimated in any other way
than simulating for the given time. - Added a function
exportSteadyStateToXLS()
to export steady state values
calculated for one simulation using thegetSteadyState()
to an Excel file
that can be imported in MoBi. - Lower limit of quantification (LLOQ) is plotted as dotted lines for
plotIndividualTimeProfile()
andplotPopulationTimeProfile()
. plotPopulationTimeProfile()
provides two new aggregations methods:
arithmetic
andgeometric
average and the ability to chose the number of
standard deviations to display around the mean through thensd
argument.- Function
calculateResiduals()
uses natural logarithm (log()
) when
calculating residuals withscaling = "log"
as opposed tolog10()
as it
was done before. This also affects figures created by
plotObservedVsSimulated()
,plotResidualsVsSimulated()
, and
plotResidualsVsTime()
. (#1091, #1087). plotPopulationTimeProfile()
has a newaggregation
argument that allow
the user to choose between quantiles, arithmetic and geometric aggregations
of y.
Minor improvements and bug fixes
- Named
Simulation
lists can be passed torunSimulations()
so that the
results are returned as a named list using the same names instead of the
simulation id. If no name is provided, the simulation id is used as before.
(#1383) - The order of columns of the data frame returned by
DataCombined$toDataFrame()
has changed. DataCombined$toDataFrame()
shows the data in the order as the data sets were added and not
alphabetically sorted.DataCombined$removeGroupAssignment()
does not show a warning if specified name is
not present in theDataCombined
.DataCombined$removeGroupAssignment()
does not produce an error if specified names are not unique.- Fixed Passing font size options from plotConfiguration objects to tlf
objects (#1198) - Legend now have transparent background by default and can be customized
through newDefaultPlotConfiguration
fields (#1216) plotObsVsPred()
now have foldDistance argument set toNULL
by default
(previously 2). The function will not add any fold lines on the plot by
default but display identity line. Set this argument toFALSE
to not draw
any lines.DefaultPlotConfiguration
has a new setting:displayLLOQ
(default TRUE)
to control plotting of LLOQ lines.DefaultPlotConfiguration
'sxLimits
andyLimits
arguments are
deprecated and replaced byxAxisLimits
andyAxisLimits
. Use them to zoom
in the plot while preserving all data points. UsexValuesLimits
and
yValuesLimits
to filter out data point outside of these range. More
detailed explanations
here.addSimulationResults
andaddDataSets
methods of theDataCombined
class
now support an optionalsilent
argument which silences the checks for data
set names. If you expect to replace data sets inDataCombined
objects
repeatedly, consider switching the parameter from the defaultFALSE
value
toTRUE
.simulationResultsToDataFrame()
is faster than before (#1317, @Felixmil).DataCombined
gets a new methodsetDataTypes()
to change data types
(observed or simulated) for existing data sets. This method is useful when
you want to enforce a certain data type, e.g., for adding artificial data
set as simulated results.- New function
setOutputs()
to change outputs ofSimulationBatch
objects.
It combinesclearOutputs()
andsetOutputs()
in one function. - New simulations life cycle flowcharts in the
vignette("efficient-calculations")
vignette. - New internal function
.setEndSimulationTime()
to set the end time of the
simulation. The function will either extend or shorten the simulation time to the specified end time. - Using
runSimulation()
is now soft deprecated in favor ofrunSimulations()
.
Version 11.3.520
Installation
-
Option 1 - install from scratch.
- Windows: package (How to install)
- Ubuntu 18: package (How to install)
- CentOS 7: package (How to install)
-
Option 2 - use docker images (NOTE: Version 11.0 is included; docker images for the version 11.3 not yet available)
Documentation
https://www.open-systems-pharmacology.org/OSPSuite-R/
What's Changed
- update core by @rwmcintosh in #1379
- Hotfix/11.3 by @Yuri05 in #1385
Full Changelog: v11.2.251...v11.3.520
Version 11.2.251
Installation
-
Option 1 - install from scratch.
- Windows: package (How to install)
- Ubuntu 18: package (How to install)
- CentOS 7: package (How to install)
-
Option 2 - use docker images (NOTE: Version 11.0 is included; docker images for the version 11.2 not yet available)
Documentation
Version 11.1.197
Installation
-
Option 1 - install from scratch.
- Windows: package (How to install)
- Ubuntu 18: package (How to install)
- CentOS 7: package (How to install)
-
Option 2 - use docker images (NOTE: Version 11.0 is included; docker images for the version 11.1 not yet available)
Documentation
https://www.open-systems-pharmacology.org/OSPSuite-R/
New features
-
Adds new visualization functions:
plotObservedVsSimulated()
for observed versus simulated data scatter plot.plotResidualsVsTime()
for time versus residuals data scatter plot.plotResidualsVsSimulated()
for simulated versus residuals data scatter plot.
-
Adds new helper functions to work with
DataCombined
objects:convertUnits()
to convert datasets inDataCombined
to common units.calculateResiduals()
to calculate residuals for datasets inDataCombined
.
Major Changes
-
The class
SimulationBatch
gets a new propertyid
. -
The output of
runSimulationBatches()
is now a named list with names being the ids ofSimulationBatch
. -
calculateResiduals()
now useslog(base = 10)
for calculation of residuals in logarithmic scale instead iflog(base = exp(1))
-
calculateResiduals()
does also return residuals for entries where simulated or observed value is 0 in logarithmic scale. These values were ignored in previous versions. If the observed or simulated value is zero or negative, it is replaced by an arbitrary small valuegetOSPSuiteSetting("LOG_SAFE_EPSILON")
(1e-20 by default).
Minor Changes
SimulationBatch$addRunValues()
will throw an error when any start value isNaN
SimulatioBatch
gets methodsgetVariableParameters()
andgetVariableMolecules()
that return list of parameter resp. molecule paths that are defined variable.
Full Changelog: v11.0.123...v11.1.197
Version 11.0.123
Installation
-
Option 1 - install from scratch.
- Windows: package (How to install)
- Ubuntu 18: package (How to install)
- CentOS 7: package (How to install)
-
Option 2 - use docker images
Documentation
https://www.open-systems-pharmacology.org/OSPSuite-R/
New features
-
Adds new
DataCombined
class that combines observed data (DataSet
) and
simulated data (SimulationResults
) into a single object. Especially
important is the$toDataFrame()
method of this object that returns a data
frame containing combined data from observed and simulated data, which can be
further used for visualizations or other analysis. -
Adds new visualization functions:
plotIndividualTimeProfile()
andplotPopulationTimeProfile()
to create
time-profile plots.
-
Adds a new class
DefaultPlotConfiguration
to provide plot configurations for
plotting functions. -
Adds
simulationResultsToDataFrame()
function to convertSimulationResults
objects into a data frame. -
All
*ToDataFrame()
functions also get*ToTibble()
variants to extract a
tibble data frame instead of a classical data frame.
Major Changes
-
Following functions are marked for deprecation and will be removed in future
releases:-
pkAnalysesAsDataFrame()
is nowpkAnalysesToDataFrame()
-
populationAsDataFrame()
is nowpopulationToDataFrame()
-
Breaking changes
-
Signature for
toUnit
function has changed.molWeight
is now the fifth,
whilesourceUnit
is the fourth parameter (#837). -
DataImporterConfiguration
: fieldstimeUnitFromColumn
and
measurementUnitFromColumn
are renamed toisTimeUnitFromColumn
and
isMeasurementUnitFromColumn
-
The constructor for
DataImporterConfiguration
does not accept a path to a
configuration file any more. Use the function
loadDataImporterConfiguration()
to create a configuration object from a
file. -
The constructor for
DataSet
objects requires aname
argument. -
All
validate*()
helper functions and"%||%"
infix operators are no longer
exported. Please have a look at the new utility package, from which these
functions are now exported:
https://www.open-systems-pharmacology.org/OSPSuite.RUtils/. -
The
pkAnalysesAsDataFrame()
function changes column data types for
QuantityPath
,Parameter
, andUnit
fromfactor
tocharacter
(#673).
Version 10.0.72
Installation
-
Option 1 - install from scratch.
- Windows: package (How to install)
- Ubuntu 18: package (How to install)
- CentOS 7: package (How to install)
-
Option 2 - use docker images
What's Changed
- 446 ensure that object ids are reset by @msevestre in #449
- Do not create new quantity objects if utilities-simulation-results if… by @PavelBal in #463
- update README by @Yuri05 in #466
- Performance improvement by @PavelBal in #469
- Fixes #444 batch simulation by @msevestre in #464
- 475 reactivate linux build by @msevestre in #477
- Fixes #467 Disable "Windows-only" tests if running under Linux by @Yuri05 in #474
- 476 mutants by @msevestre in #479
- Fixes #423 export population to csv by @msevestre in #480
- Fixes #436 calculate pk fail by @msevestre in #481
- Fixes #473 usability issue by @msevestre in #482
- Fixes #295 population calculation aging by @msevestre in #484
- 471 document update by @msevestre in #485
- WIP #486 expose data repository by @msevestre in #487
- Added methods for working with enums. by @PavelBal in #491
- Fixes #493 units for dimensions by @msevestre in #494
- Fixes #496 expose enum by @msevestre in #497
- create getUnitsEnum and getDimensionsEnum functions #478 by @abdullahhamadeh in #499
- Fixes #498 depends on major by @msevestre in #500
- Utilities dimensions by @PavelBal in #495
- Fixes #503 debug output by @msevestre in #504
- temporarily disable print test under Linux (s. #435) by @Yuri05 in #509
- Parallel run by @PavelBal in #511
- Fixes #506 by @abdullahhamadeh in #514
- Concurrent simulation batch by @PavelBal in #513
- Fixes #515 by @PavelBal in #516
- Using low-level rCrl methods in getOutputValues by @PavelBal in #518
- Add getAllStateVariablesPaths by @PavelBal in #526
- Update core by @msevestre in #527
- Fixes #528 Update CentOS package for SimModel by @Yuri05 in #530
- Fixes #531 version 4 by @msevestre in #532
- Fixes #428 get all parameter matching by @msevestre in #534
- Fixes #541 extend set parameter value by path by @msevestre in #543
- Updated to latest SimModel by @Yuri05 in #545
- Vignettes: typos, links by @Yuri05 in #547
- Vignettes: typos by @Yuri05 in #548
- Update Core (and SimModel in inst folder) by @Yuri05 in #554
- Moved files required for vignettes to inst folder by @PavelBal in #560
- WIP #544 by @msevestre in #546
- 568 error message readr by @pchelle in #571
- Update README.md by @PavelBal in #572
- Fixes #561 lloq data set by @msevestre in #574
- Load data set from PKML by @PavelBal in #579
- Fixes #582 add CL parameters by @msevestre in #584
- Fixes #583 allow null and NA by @msevestre in #585
- Fixes #570 by @hannaei in #586
- Added method for exporting DataSet as PKML by @PavelBal in #580
- Fixes #581 batch run crash by @msevestre in #590
- Add test for adding simulation batch run values after running by @PavelBal in #591
- Fixes #592 only expose one method by @msevestre in #593
- Data importer by @PavelBal in #589
- 542 efficient calculation by @msevestre in #596
- update vignette for efficient calculations by @PavelBal in #598
- Data set from excel by @PavelBal in #599
- correct spelling errors by @IndrajeetPatil in #602
- consistently use markdown syntax in rd docs by @IndrajeetPatil in #605
- Fix dataSetToDataFrame by @PavelBal in #606
- 587 get seed by @msevestre in #607
- Fixes #611 no instead of default. Best pracitces for R project by @msevestre in #612
- Fixes #614 and also Fixes #615 by @msevestre in #616
- Fixes #553 integer unit by @msevestre in #617
- change round brackets to square brackets in dimension names by @abdullahhamadeh in #608
- Fixing tests using ospUnits by @PavelBal in #619
- add a static website for the package by @IndrajeetPatil in #624
- Fixes #621 minimum r version by @msevestre in #622
- Fixes #613 news by @msevestre in #632
- Set quantity values with units by @PavelBal in #630
- fixes malformed README by @IndrajeetPatil in #636
- 626 errors in validate by @msevestre in #633
- update website oct 1 by @IndrajeetPatil in #638
- Fixes #635 reorder vignettes by @msevestre in #639
- add "Get Started" vignette by @IndrajeetPatil in #640
- Version 10.0 by @msevestre in #631
- Fixes #647 New dataset tests fail on Linux (tests temporarily disabled) by @Yuri05 in #649
- Fixes #646 inconsistent behavior by @msevestre in https://github.com/Open-Sy...
Version 10.0.70
Installation
-
Option 1 - install from scratch.
- Windows: package (How to install)
- Ubuntu 18: package (How to install)
- CentOS 7: package (How to install)
-
Option 2 - use docker images
What's Changed
- 446 ensure that object ids are reset by @msevestre in #449
- Do not create new quantity objects if utilities-simulation-results if… by @PavelBal in #463
- update README by @Yuri05 in #466
- Performance improvement by @PavelBal in #469
- Fixes #444 batch simulation by @msevestre in #464
- 475 reactivate linux build by @msevestre in #477
- Fixes #467 Disable "Windows-only" tests if running under Linux by @Yuri05 in #474
- 476 mutants by @msevestre in #479
- Fixes #423 export population to csv by @msevestre in #480
- Fixes #436 calculate pk fail by @msevestre in #481
- Fixes #473 usability issue by @msevestre in #482
- Fixes #295 population calculation aging by @msevestre in #484
- 471 document update by @msevestre in #485
- WIP #486 expose data repository by @msevestre in #487
- Added methods for working with enums. by @PavelBal in #491
- Fixes #493 units for dimensions by @msevestre in #494
- Fixes #496 expose enum by @msevestre in #497
- create getUnitsEnum and getDimensionsEnum functions #478 by @abdullahhamadeh in #499
- Fixes #498 depends on major by @msevestre in #500
- Utilities dimensions by @PavelBal in #495
- Fixes #503 debug output by @msevestre in #504
- temporarily disable print test under Linux (s. #435) by @Yuri05 in #509
- Parallel run by @PavelBal in #511
- Fixes #506 by @abdullahhamadeh in #514
- Concurrent simulation batch by @PavelBal in #513
- Fixes #515 by @PavelBal in #516
- Using low-level rCrl methods in getOutputValues by @PavelBal in #518
- Add getAllStateVariablesPaths by @PavelBal in #526
- Update core by @msevestre in #527
- Fixes #528 Update CentOS package for SimModel by @Yuri05 in #530
- Fixes #531 version 4 by @msevestre in #532
- Fixes #428 get all parameter matching by @msevestre in #534
- Fixes #541 extend set parameter value by path by @msevestre in #543
- Updated to latest SimModel by @Yuri05 in #545
- Vignettes: typos, links by @Yuri05 in #547
- Vignettes: typos by @Yuri05 in #548
- Update Core (and SimModel in inst folder) by @Yuri05 in #554
- Moved files required for vignettes to inst folder by @PavelBal in #560
- WIP #544 by @msevestre in #546
- 568 error message readr by @pchelle in #571
- Update README.md by @PavelBal in #572
- Fixes #561 lloq data set by @msevestre in #574
- Load data set from PKML by @PavelBal in #579
- Fixes #582 add CL parameters by @msevestre in #584
- Fixes #583 allow null and NA by @msevestre in #585
- Fixes #570 by @hannaei in #586
- Added method for exporting DataSet as PKML by @PavelBal in #580
- Fixes #581 batch run crash by @msevestre in #590
- Add test for adding simulation batch run values after running by @PavelBal in #591
- Fixes #592 only expose one method by @msevestre in #593
- Data importer by @PavelBal in #589
- 542 efficient calculation by @msevestre in #596
- update vignette for efficient calculations by @PavelBal in #598
- Data set from excel by @PavelBal in #599
- correct spelling errors by @IndrajeetPatil in #602
- consistently use markdown syntax in rd docs by @IndrajeetPatil in #605
- Fix dataSetToDataFrame by @PavelBal in #606
- 587 get seed by @msevestre in #607
- Fixes #611 no instead of default. Best pracitces for R project by @msevestre in #612
- Fixes #614 and also Fixes #615 by @msevestre in #616
- Fixes #553 integer unit by @msevestre in #617
- change round brackets to square brackets in dimension names by @abdullahhamadeh in #608
- Fixing tests using ospUnits by @PavelBal in #619
- add a static website for the package by @IndrajeetPatil in #624
- Fixes #621 minimum r version by @msevestre in #622
- Fixes #613 news by @msevestre in #632
- Set quantity values with units by @PavelBal in #630
- fixes malformed README by @IndrajeetPatil in #636
- 626 errors in validate by @msevestre in #633
- update website oct 1 by @IndrajeetPatil in #638
- Fixes #635 reorder vignettes by @msevestre in #639
- add "Get Started" vignette by @IndrajeetPatil in #640
- Version 10.0 by @msevestre in #631
New Contributors
- @abdullahhamadeh made their first contribution in #499
- @hannaei made their first contribution in https://github.com/Open-Systems-Pharmacology/OSPS...
Version 10.0.25
This release includes some bug fixes and minor new features (s. the list of modifications)
Installation
-
Option 1 - install from scratch.
- Windows: package (How to install)
- Ubuntu 18: package (How to install)
- CentOS 7: package (How to install)
-
Option 2 - use docker images
Version 9.1.4
Version 9.1.4.. This can be used as replacement of existing 9.1.x release
Version 9.1.2
This is the same version as 9.1. The only change is that the default version in the description file was updated
If you are using 9.1.1 already, there is no need to update to this package