The hardware and bandwidth for this mirror is donated by dogado GmbH, the Webhosting and Full Service-Cloud Provider. Check out our Wordpress Tutorial.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]dogado.de.

admiral

CRAN status Test Coverage

ADaM in R Asset Library

Purpose

To provide an open source, modularized toolbox that enables the pharmaceutical programming community to develop ADaM datasets in R.

Installation

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

install.packages("admiral")

To install the development version of the package from GitHub run:

# install.packages("devtools")
devtools::install_github("pharmaverse/admiral")

Cheat Sheet

Release Schedule

The {admiral} family has several downstream and upstream dependencies and so releases are done in two Phases:

Release Schedule Phase 1- Date and Packages Phase 2- Date and Packages
Q4-2024 December 2nd December 9th
{pharmaversesdtm} {admiralonco}
{admiraldev} {admiralophtha}
{admiral} {admiralvaccine}
Q2-2025 June 2nd June 10th
{pharmaversesdtm} {admiralonco}
{admiraldev} {admiralophtha}
{admiral} {admiralvaccine}

Main Goal

Provide users with an open source, modularized toolbox with which to create ADaM datasets in R. As opposed to a “run 1 line and an ADaM appears” black-box solution or an attempt to automate ADaM.

One of the key aspects of {admiral} is its development by the users for the users. It gives an entry point for all to collaborate, co-create and contribute to a harmonized approach of developing ADaMs in R across the pharmaceutical industry.

Scope

To set expectations: It is not our target that {admiral} will ever provide all possible solutions for all ADaM datasets outside of study specific needs. It depends on the user’s collaboration and contribution to help grow over time to an asset library that is robust, easy to use and has an across-industry focus. We do not see a coverage of 100% of all ADaM derivations as ever achievable—ADaM is endless.

We will provide:

The {admiral} Family of Packages

There are three types of packages in the {admiral} family:

Related data packages include:

Both these packages are developed by the {admiral} team, but can used across the pharmaverse as common, open-source test SDTM or ADaM data.

The following packages are also useful when working with ADaM datasets:

Admiral Manifesto

For {admiral} and all extension packages, we prioritize providing our users with a simple to adopt toolkit that enables them to produce readable and easily constructible ADaM programs. The following explains our philosophy, which we try to adhere to across the {admiral} family of packages. There isn’t always a clear single, straightforward rule, but there are guiding principles we adhere to for {admiral}. This manifesto helps show the considerations of our developers when making decisions.

We have four design principles to achieve the main goal:

Usability

All {admiral} functions should be easy to use.

Simplicity

All {admiral} functions have a clear purpose.

Findability

All {admiral} functions are easily findable.

Readability

All {admiral} functions follow the Programming Strategy that all our developers and contributors must follow, so that all our code has a high degree of consistency and readability.

References and Documentation

Pharmaverse Blog

If you are interested in R and Clinical Reporting, then visit the pharmaverse blog. This contains regular, bite-sized posts showcasing how {admiral} and other packages in the pharmaverse can be used to realize the vision of full end-to-end Clinical Reporting in R.

We are also always looking for keen {admiral} users to publish their own blog posts about how they use the package. If this could be you, feel free make an issue in the GitHub repo and get started!

Recent Conference Presentations

For a full collection of {admiral} conference presentations over the years, please travel to our Presentation Archive.

Contact

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

Acknowledgments

Along with the authors and contributors, thanks to the following people for their work on the package:

Jaxon Abercrombie, Mahdi About, Teckla Akinyi, James Black, Claudia Carlucci, Asha Chakma, Bill Denney, Kamila Duniec, Alice Ehmann, Romain Francois, Ania Golab, Alana Harris, Declan Hodges, Anthony Howard, Shimeng Huang, Samia Kabi, James Kim, John Kirkpatrick, Leena Khatri, Robin Koeger, Konstantina Koukourikou, Pavan Kumar, Pooja Kumari, Shan Lee, Wenyi Liu, Iain McCay, Jack McGavigan, Jordanna Morrish, Syed Mubasheer, Thomas Neitmann, Yohann Omnes, Barbara O’Reilly, Hamza Rahal, Nick Ramirez, Tom Ratford, Sukalpo Saha, Tamara Senior, Sophie Shapcott, Ondrej Slama, Andrew Smith, Daniil Stefonishin, Vignesh Thanikachalam, Michael Thorpe, Annie Yang, Ojesh Upadhyay and Franciszek Walkowiak.

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.
Health stats visible at Monitor.