Package: ubiquity 2.1.1

ubiquity: PKPD, PBPK, and Systems Pharmacology Modeling Tools

Complete work flow for the analysis of pharmacokinetic pharmacodynamic (PKPD), physiologically-based pharmacokinetic (PBPK) and systems pharmacology models including: creation of ordinary differential equation-based models, pooled parameter estimation, individual/population based simulations, rule-based simulations for clinical trial design and modeling assays, deployment with a customizable 'Shiny' app, and non-compartmental analysis. System-specific analysis templates can be generated and each element includes integrated reporting with 'PowerPoint' and 'Word'.

Authors:John Harrold [aut, cre]

ubiquity_2.1.1.tar.gz
ubiquity_2.1.1.zip(r-4.7)ubiquity_2.1.1.zip(r-4.6)ubiquity_2.1.1.zip(r-4.5)
ubiquity_2.1.1.tgz(r-4.6-any)ubiquity_2.1.1.tgz(r-4.5-any)
ubiquity_2.1.1.tar.gz(r-4.7-any)ubiquity_2.1.1.tar.gz(r-4.6-any)
ubiquity_2.1.1.tgz(r-4.6-emscripten)
manual.pdf |manual.html
DESCRIPTION |NEWS
card.svg |card.png
ubiquity/json (API)

# Install 'ubiquity' in R:
install.packages('ubiquity', repos = c('https://john-harrold.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/john-harrold/ubiquity/issues

Pkgdown/docs site:https://r.ubiquity.tools

On CRAN:

Conda:

modelingpkpd

6.81 score 14 stars 57 scripts 215 downloads 84 exports 101 dependencies

Last updated from:a6af2e725c. Checks:7 NOTE, 2 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64NOTE596
source / vignettesOK314
linux-release-x86_64NOTE606
macos-release-arm64NOTE495
macos-oldrel-arm64NOTE566
windows-develNOTE657
windows-releaseNOTE776
windows-oldrelNOTE771
wasm-releaseOK186

Exports:apply_sub_file_COVbuild_systemcalculate_halflifecalculate_objectivecheck_depsfetch_full_parametersfind_bracketed_argumentsgenerate_parametergenerate_subjectgg_axisgg_log10_xaxisgg_log10_yaxisGUI_log_entrylinspacelogspacenm_select_recordspad_stringparse_patternsprepare_figurerun_simulation_titraterun_simulation_ubiquitysimulate_subjectssom_to_dfsystem_check_requirementssystem_check_steady_statesystem_clear_cohortssystem_define_cohortsystem_define_cohorts_nmsystem_estimate_parameterssystem_fetch_guesssystem_fetch_iivsystem_fetch_ncasystem_fetch_nca_columnssystem_fetch_parameterssystem_fetch_rpt_officer_objectsystem_fetch_rpt_onbrand_objectsystem_fetch_setsystem_fetch_templatesystem_fetch_TSsyssystem_glp_initsystem_glp_scenariosystem_load_datasystem_log_debug_savesystem_log_entrysystem_log_initsystem_nca_parameters_metasystem_nca_runsystem_nca_summarysystem_newsystem_new_listsystem_new_tt_rulesystem_od_generalsystem_plot_cohortssystem_rpt_add_doc_contentsystem_rpt_add_slidesystem_rpt_estimationsystem_rpt_ncasystem_rpt_read_templatesystem_rpt_save_reportsystem_rpt_template_detailssystem_select_setsystem_set_bolussystem_set_covariatesystem_set_guesssystem_set_iivsystem_set_optionsystem_set_parametersystem_set_ratesystem_set_rpt_officer_objectsystem_set_rpt_onbrand_objectsystem_set_tt_bolussystem_set_tt_condsystem_set_tt_ratesystem_simulate_estimation_resultssystem_ts_to_simtimesystem_viewsystem_zero_inputstictimecourse_statstocvar2stringvar2string_genvpworkshop_fetch

Dependencies:askpassbackportsbase64encbslibcachemcellrangercheckmateclicodetoolscommonmarkcpp11crayondata.tabledeSolvedigestdoParalleldplyrevaluatefarverfastmapflextablefontawesomefontBitstreamVerafontLiberationfontquiverforeachfsgdtoolsgenericsggplot2gluegtablehighrhmshtmltoolshtmlwidgetshttpuvisobanditeratorsjquerylibjsonliteknitrlabelinglaterlatticelifecyclemagrittrMASSmemoisemimenlmenloptrnumDerivofficeronbrandopenssloptimxotelpillarpkgconfigPKNCApracmaprettyunitsprogresspromisespsopurrrR6raggrappdirsRColorBrewerRcppreadxlrematchrhandsontablerlangrmarkdownS7sassscalesshinysourcetoolsstringistringrsyssystemfontstextshapingtibbletidyrtidyselecttinytexutf8uuidvctrsviridisLitewithrxfunxml2xtableyamlzip

Naive-Pooled Parameter Estimation
Introduction | Least squares estimation/single output (analysis_parent.r) | Automated Reporting | PowerPoint | Word | Maximum likelihood/two outputs (analysis_parent_metabolite.r) | Global estimation routines (analysis_parent_metabolite_global.r) | Cohorts from NONMEM dataset (analysis_parent_metabolite_nm_data.r) | Contents of system.txt

Last update: 2026-01-03
Started: 2018-03-04

Noncompartmental Analysis
Introduction | Quick Template for Running NCA | Single Dose Data | Expected Format of Data | NCA and Outputs | Automated Reporting | PowerPoint | Word | Summarizing Data | Multiple Dose Data | Sparse Sampling

Last update: 2025-12-30
Started: 2019-07-08

Analysis of Static Systems, an In Vitro Example
Introduction | The sysem file: system-in_vitro.txt | The dataset: in_vitro_er_data.csv | The analysis script: analysis_in_vitro.R | Output times | Making a dynamic simulation static: | Datasets | Defining cohorts | Postprocessing | Results | Contents of system-in_vitro.txt

Last update: 2025-03-22
Started: 2024-10-20

Individual and Population Simulations
Introduction | Simulating an Individual Response (analysis_single.r) | Simulating Population Response From IIV (analysis_multiple.r) | Simulating Population Response From File (analysis_multiple_file.r) | Parallelization | Contents of system.txt

Last update: 2025-03-22
Started: 2018-03-04

Titration/Rule-Based Simulations
Introduction | Repeated Bolus Dosing (analysis_repeat_dosing.r) | Repeated Infusions (analysis_repeat_infusion.r) | Titrated Dosing (analysis_visit_dosing_titration.r) | Monte Carlo Simulations (analysis_visit_dosing_titration_stochastic.r) | Performing State/Compartment Resets (analysis_state_reset.r) | Contents of system.txt

Last update: 2025-03-22
Started: 2018-03-04

Modeling Language
Introduction | Parameters | System parameters <P> | Parameter sets | Secondary parameters <As> and <Ad> | Variance parameters <VP> | Parameter estimation information <EST:?>? | Variability: defining the variance/covariance Matrix <IIV:?>? & <IIVCOR:?>? | IIV and parameter sets <IIVSET:?>? & <IIVCORSET:?>? | Differential equations | Writing ODEs <ODE:?> | Rate equations =?=> | Equilibrium relationships <=kforward:kreverse=> | Sources and sinks <S:?> | Movement between compartments <C> | Bringing it all together | Initial conditions <I> | Model inputs | Bolus dosing <B:times>, <B:events> | Continuous infusions <R:?> | Covariates <CV:?>, <CVSET:?:?> | Simple covariates | Complicated covariates | Model outputs | Output error model <OE:?> ? | Functions and operators | Current simulation time | Modeling quasi-equilibrium of target-mediated drugs | Timescales | Mathematical sets | Set notation <SET:?>? | Aligning Sets | Set Functions | Set Evaluation | Piecewise-continuous functions/parameters <IF:?:?> | Constructing a piece-wise continuous function/parameter | Controlling indices | Concentrations vs amounts | Options | Example system files | Templates | R workflow | Matlab workflow | Other Software Targets | References

Last update: 2025-03-21
Started: 2018-03-04

Report Generation
Introduction | Implenting onbrand in ubiquity | Reporting workshop files | PowerPoint reports (make_report_PowerPoint.R) | Creating some content | Creating a new report | Adding slides to a report | Adding lists | Adding figures | Adding tables | Saving the report | Word reports (make_report_Word.R) | Adding content to the report | Adding text | Other content and formatting | Using custom organizational templates | PowerPoint | Word | Using the custom templates | Integration with ubiquity workflows | Parameter estimation | Non-compartmental analysis (NCA) | Modifying reports directly with officer | Wrapper mapping between ubiquity and onbrand functions

Last update: 2024-03-07
Started: 2018-03-04

Model Deployment
Introduction | Running the model | Altering dosing | Population simulations | Saving model results | Model scripts | Controlling what is saved | Model documentation | Model diagram | Model reports | User definable functions | Custom simulation commands | Custom plotting commands | Deployment on a Shiny Server

Last update: 2021-12-05
Started: 2018-04-27

Readme and manuals

Help Manual

Help pageTopics
Build the System Filebuild_system
Calculate the halflife of datacalculate_halflife
Implementation of Matlab 'toc()' commandcheck_deps
Make Pretty ggplot x- or y-Axis Log 10 Scalegg_axis
Make Pretty ggplot x-Axis Log 10 Scalegg_log10_xaxis
Make Pretty ggplot y-Axis Log 10 Scalegg_log10_yaxis
Implementation of the 'linspace' Function from Matlablinspace
Implementation of the 'logspace' Function from Matlablogspace
Pad String with Spacespad_string
Make ggplot Figure Prettyprepare_figure
Simulate With Titration or Rule-Based Inputsrun_simulation_titrate
Simulate Individual Responserun_simulation_ubiquity
Run Population Simulationssimulate_subjects
Converts the Wide/Verbose Output Simulation Functions into Data Framessom_to_df
Check For Perl and C Toolssystem_check_requirements
Verify System Steady Statesystem_check_steady_state
Clear all Cohortssystem_clear_cohorts
Define Estimation Cohortsystem_define_cohort
Define Cohorts from NONMEM Input Filesystem_define_cohorts_nm
Control Estimation Processsystem_estimate_parameters
Fetch Current Parameter Guessessystem_fetch_guess
Fetch Variability Termssystem_fetch_iiv
Fetch NCA Resultssystem_fetch_nca
Columns in NCA Analysissystem_fetch_nca_columns
Fetch System Parameterssystem_fetch_parameters
Extracts the officer Object From the Specified ubiquity Reportsystem_fetch_rpt_officer_object
Extracts the onbrand Object From the Specified ubiquity Reportsystem_fetch_rpt_onbrand_object
Fetch Mathematical Setsystem_fetch_set
Create New Analysis Templatesystem_fetch_template
Fetch System Timescalesystem_fetch_TSsys
Initialize GLP study designsystem_glp_init
Design GLP Study For a Scenariosystem_glp_scenario
Loading Datasetssystem_load_data
Save variables to filessystem_log_debug_save
Initialize System Log Filesystem_log_init
List NCA parameters, text names and descriptionssystem_nca_parameters_meta
Automatic NCAsystem_nca_run
Summarize NCA Results in Tabular Formatsystem_nca_summary
Create New 'system.txt' Filesystem_new
Fetch List of Available System Templatessystem_new_list
Titration Rulessystem_new_tt_rule
General Observation Details Functionsystem_od_general
Plot Estimation Resultssystem_plot_cohorts
Adds Content to a Word Reportsystem_rpt_add_doc_content
Add Slide to a Powerpoint Reportsystem_rpt_add_slide
Generate a Report from Parameter Estimationsystem_rpt_estimation
Report NCAsystem_rpt_nca
Initialize a New Reportsystem_rpt_read_template
Save Report to a Filesystem_rpt_save_report
Generate Details about Report Templatesystem_rpt_template_details
Selecting Parameter Setssystem_select_set
Set Bolus Inputssystem_set_bolus
Set Covariate Valuessystem_set_covariate
Alter Initial Guess and Parameter Boundssystem_set_guess
Set Variability Termssystem_set_iiv
Setting Analysis Optionssystem_set_option
Set Value for Parametersystem_set_parameter
Set Infusion Rate Inputssystem_set_rate
Sets the officer Object for the Specified ubiquity Reportsystem_set_rpt_officer_object
Sets the onbrand Object for the Specified ubiquity Reportsystem_set_rpt_onbrand_object
Define Titration Triggers and Actionssystem_set_tt_cond
Actual Function Called by 'SI_TT_RATE'system_set_tt_rate
Simulate Results at Estimatessystem_simulate_estimation_results
View Information About the Systemsystem_view
Zero All Model Inputssystem_zero_inputs
Implementation of Matlab 'tic()' commandtic
Implementation of Matlab 'toc()' commandtoc
Converts Numeric Variables into Padded Stringsvar2string
Print and Log Messagesvp
Fetch Ubiquity Workshop Sectionsworkshop_fetch