Skip to contents

Get Started

Source: vignettes/admiralonco.Rmd
admiralonco.Rmd

Introduction

As this is a package extension, if you are new to admiral then the best place to first start reading would be this Get Started guide. This extension package follows the same main idea and conventions, and re-uses many functions from admiral, so it is important to thoroughly understand these to be able to use {admiralonco}.

Derivations

The most important functions in {admiralonco} are the derivations. Again these follow the same conventions as admiral but are focused to oncology-specific needs.

Starting a Script

For the oncology ADaM data structures, an overview of the flow and example function calls for the most common steps are provided by the following vignettes:

{admiralonco} also provides template R scripts as a starting point. They can be created by calling use_ad_template() from {admiral}, e.g.,

use_ad_template(
  adam_name = "adrs",
  save_path = "./ad_adrs.R",
  package = "admiralonco"
)

A list of all available templates can be obtained by list_all_templates() from {admiral}:

list_all_templates(package = "admiralonco")
#> Existing ADaM templates in package 'admiralonco':
#> • ADRS
#> • ADTTE

Support

Support is provided via the admiral Slack channel.