Skip to content

Latest commit

 

History

History
93 lines (67 loc) · 3.37 KB

README.md

File metadata and controls

93 lines (67 loc) · 3.37 KB
Raw

admiralonco

CRAN status

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

Purpose

To provide a complementary (to {admiral}) toolbox that enables users to develop oncology disease area specifics.

Installation

The package is available from CRAN and can be installed with:

install.packages("admiralonco")

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 {admiralonco}
remotes::install_github("pharmaverse/admiral") # This is a required dependency of {admiralonco}
remotes::install_github("pharmaverse/admiralonco")

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 {admiralonco} was released. For example, admiralonco 0.3.0 was released on 2023-03-14. I.e., it will work with the latest version of packages available at that date, e.g., admiral 0.10.

Scope

  • Build a toolbox of re-usable functions and utilities to create oncology-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 the most common efficacy endpoint needs for solid tumor (using RECIST v1.1 response criteria), but over time we will look to add extra areas such as: endpoints for targeted indications, baseline disease characteristics, common sensitivity analyses and questionnaires.

Expectations

{admiralonco} is expected to complement {admiral} and provide functions to help with the creation of the efficacy endpoints required for oncology 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 {admiralonco} 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