Package: vmxr 0.3.0

Eric Novik

vmxr: VeloMetrix R Client

A native R client for the VeloMetrix REST API (vmx-api). Wraps the treatment-to-simulation analysis workflow in ergonomic, pipe-friendly verbs that block-and-poll for asynchronous server jobs and return native R objects (tibbles and typed S3 objects). The package orchestrates server-side jobs; it holds no business logic of its own. Targets API 0.2.x and 0.3 / CLI 0.6.x.

Authors:Eric Novik [aut, cre], Juho Timonen [ctb], Generable [cph, fnd]

vmxr_0.3.0.tar.gz
vmxr_0.3.0.zip(r-4.7-any)vmxr_0.3.0.zip(r-4.6-any)vmxr_0.3.0.zip(r-4.5-any)
vmxr_0.3.0.tgz(r-4.6-any)vmxr_0.3.0.tgz(r-4.5-any)
vmxr_0.3.0.tar.gz(r-4.7-any)vmxr_0.3.0.tar.gz(r-4.6-any)
vmxr_0.3.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
vmxr/json (API)

# Install 'vmxr' in R:

install.packages('vmxr', repos = c('https://generable.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/generable/vmxr/issues

On CRAN:

3.95 score 4 scripts 84 exports 18 dependencies

Last updated from:ee9981139c. Checks:9 OK. Indexed: yes.

Target	Result	Time
linux-devel	OK	177
source / vignettes	OK	461
linux-release	OK	198
macos-release	OK	213
macos-oldrel	OK	430
windows-devel	OK	123
windows-release	OK	123
windows-oldrel	OK	105
wasm-release	OK	128

Exports:as_tibble vmx_all_specimens vmx_analysis_log vmx_client vmx_data_version vmx_data_version_archive vmx_data_version_create vmx_data_version_export vmx_data_version_table vmx_data_version_unarchive vmx_data_versions vmx_dataset vmx_dataset_cancel vmx_dataset_download vmx_dataset_files vmx_dataset_tags vmx_datasets vmx_dosing vmx_dosing_input vmx_dosing_input_status vmx_fit_global_estimates vmx_fit_obs_vs_pred vmx_fit_subject_estimates vmx_fit_vpc vmx_health vmx_login vmx_model_build vmx_model_build_artifacts vmx_model_build_cancel vmx_model_build_events vmx_model_build_export vmx_model_build_logs vmx_model_build_marker_selection vmx_model_build_report vmx_model_build_report_create vmx_model_build_results vmx_model_build_runs vmx_model_build_status vmx_model_catalog vmx_model_data vmx_model_describe vmx_model_fit vmx_model_fit_marker_selection vmx_model_fit_postprocessor_status vmx_model_fits vmx_modeling_options vmx_nca vmx_nca_analyses vmx_nca_get vmx_nca_marker_selection vmx_nca_result vmx_nlmixr_data vmx_nlmixr_default_cmt vmx_pd vmx_pd_marker vmx_pk vmx_prep_answer vmx_prep_questions vmx_prep_status vmx_sim_cancel vmx_sim_existing_subject vmx_sim_existing_subject_from_text vmx_sim_hypothetical_subject vmx_sim_hypothetical_subject_from_text vmx_sim_jobs vmx_sim_population vmx_sim_population_from_text vmx_sim_result vmx_sim_status vmx_studies vmx_study vmx_study_create vmx_study_update vmx_subjects vmx_torsten_data vmx_treatment vmx_treatment_create vmx_treatment_update vmx_treatments vmx_upload vmx_upload_ignore vmx_upload_unignore vmx_wait vmx_whoami

Dependencies:askpass cli curl glue httr2 jsonlite lifecycle magrittr openssl pillar pkgconfig R6 rlang sys tibble utf8 vctrs withr

Getting started with vmxr

Authentication | The whole workflow, in-session | Model-ready data into R | Fit a model and pull diagnostics

Rendered fromgetting-started.Rmdusingknitr::rmarkdown

Last update: 2026-10-27
Started: 2026-06-30

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
Select all specimens	vmx_all_specimens
Audit / analysis log for a study	vmx_analysis_log
Create a vmxr client	vmx_client
Fetch one data version	vmx_data_version
Archive a data version	vmx_data_version_archive
Create a data version	vmx_data_version_create
Export a data version	vmx_data_version_export
A prepared data-version table	vmx_data_version_table
Unarchive a data version	vmx_data_version_unarchive
List data versions	vmx_data_versions
Fetch one dataset	vmx_dataset
Cancel a dataset's in-flight format job	vmx_dataset_cancel
Download a dataset's files	vmx_dataset_download
List the files in a dataset	vmx_dataset_files
The tags on a dataset	vmx_dataset_tags
List datasets	vmx_datasets
Dosing events table	vmx_dosing
Create a dosing input for a fit	vmx_dosing_input
Dosing-input status	vmx_dosing_input_status
Global (population) parameter estimates (tidy)	vmx_fit_global_estimates
Observed-vs-predicted diagnostic (tidy)	vmx_fit_obs_vs_pred
Subject-level parameter estimates (tidy, long)	vmx_fit_subject_estimates
Visual predictive check artifact	vmx_fit_vpc
Connectivity probe	vmx_health
Authenticate to VeloMetrix via OIDC device-code	vmx_login
Accepted specimen selections of an NCA, model-build run or model fit	vmx_marker_selection vmx_model_build_marker_selection vmx_model_fit_marker_selection vmx_nca_marker_selection
Start a model build run (optionally wait)	vmx_model_build
Download build-run artifacts	vmx_model_build_artifacts
Cancel a build run	vmx_model_build_cancel
Build-run events (SSE stream)	vmx_model_build_events
Markdown export of a build run	vmx_model_build_export
Build-run logs	vmx_model_build_logs
Build-run report status (signed HTML report URL when ready)	vmx_model_build_report
Request build-run report generation	vmx_model_build_report_create
Build-run results	vmx_model_build_results
List model build runs	vmx_model_build_runs
Build-run status	vmx_model_build_status
Model catalog	vmx_model_catalog
Fetch model-ready tidy tables for a data version	vmx_model_data
Describe a model	vmx_model_describe
Fetch one model fit's details	vmx_model_fit
Model-fit postprocessor status	vmx_model_fit_postprocessor_status
List model fits	vmx_model_fits
Preview modeling options for a data version	vmx_modeling_options
Run an NCA analysis	vmx_nca
List NCA analyses	vmx_nca_analyses
Fetch one NCA analysis	vmx_nca_get
NCA result table (PK parameters, per subject and result interval)	vmx_nca_result
NONMEM-layout event dataset for nlmixr2 / rxode2	vmx_nlmixr_data
Default route-to-compartment mapping for 'vmx_nlmixr_data()'	vmx_nlmixr_default_cmt
PD observations table	vmx_pd
Select a PD marker in one specimen or in all specimens	vmx_pd_marker
PK observations table	vmx_pk
Answer prep questions and resume formatting	vmx_prep_answer
Questions raised by prep (when awaiting input)	vmx_prep_questions
Prep status for a dataset	vmx_prep_status
Cancel a simulation job	vmx_sim_cancel
Simulate existing (observed) subjects	vmx_sim_existing_subject
Simulate existing subjects from dosing text	vmx_sim_existing_subject_from_text
Simulate hypothetical subjects	vmx_sim_hypothetical_subject
Simulate hypothetical subjects from dosing text	vmx_sim_hypothetical_subject_from_text
List simulation jobs for a model fit	vmx_sim_jobs
Simulate a population scenario	vmx_sim_population
Simulate a population scenario from dosing text	vmx_sim_population_from_text
Simulation result	vmx_sim_result
Simulation job status	vmx_sim_status
List studies for a treatment	vmx_studies
Fetch one study	vmx_study
Create a study	vmx_study_create
Update a study	vmx_study_update
Subjects table (one row per subject)	vmx_subjects
Ragged-array data list for Stan / Torsten	vmx_torsten_data
Fetch one treatment	vmx_treatment
Create a treatment	vmx_treatment_create
Update a treatment	vmx_treatment_update
List treatments	vmx_treatments
Upload files to a study	vmx_upload
Ignore an upload within a dataset	vmx_upload_ignore
Reverse a prior upload ignore	vmx_upload_unignore
Block until an async handle reaches a terminal state	vmx_wait
Confirm the configured PAT and report identity	vmx_whoami