/admiralmetabolic

Metabolic package extension of admiral

Primary LanguageRApache License 2.0Apache-2.0

admiralmetabolic

Metabolism extension package for ADaM in R Asset Library {admiral}

Purpose

To provide a complementary (to {admiral}) toolbox that enables users to develop specifics for metabolic clinical trials.

Installation

To install the latest development version of the package directly from GitHub use the following code:

if (!requireNamespace("remotes", quietly = TRUE)) {
  install.packages("remotes")
}

remotes::install_github("pharmaverse/admiraldev") # This is a required dependency of {admiralmetabolic}
remotes::install_github("pharmaverse/admiral") # This is a required dependency of {admiralmetabolic}
remotes::install_github("pharmaverse/admiralmetabolic")

Dependencies

The latest version of the package works with the latest versions of the packages stated in DESCRIPTION.

If a previous version of the package should be used, it is recommended to use latest version of the dependencies at the point of time when the previous version of {admiralmetabolic} was released.

Scope

  • Build a toolbox of re-usable functions and utilities to create metabolism-specific ADaM datasets in R in a modular manner.
  • All functions are created based upon the ADaM Implementation Guide and aim to facilitate the programming of ADaM dataset standards.
  • Initially the package will focus on .

Expectations

{admiralmetabolic} is expected to complement {admiral} and provide functions to help with the creation of analyses required for metabolic trial ADaMs.

References and Documentation

R Versions

Here’s a summary of our strategy for this package related to R versions:

  • R versions for developers and users will follow the same as {admiral} core package.
  • For development the main branch of {admiral} core is used as a dependency. For releasing a new {admiralmetabolic} version it must run using the latest released {admiral} core version.

Contact

We use the following for support and communications between user and developer community:

  • Slack - for informal discussions, Q&A and building our user community. If you don't have access, use this link to join the pharmaverse Slack workspace
  • GitHub Issues - for direct feedback, enhancement requests or raising bugs