# Get Started

# 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 `{admiralvaccine}`. s # Derivations

The most important functions in `{admiralvaccine}` follow the same conventions as `{admiral}` but are focused to vaccine-specific needs. Please refer the Reference Page for more details.

# Input and Output

It is expected that the input dataset is not grouped. Otherwise an error is issued.

The output dataset is ungrouped. The observations are not ordered in a dedicated way. In particular, the order of the observations of the input dataset may not be preserved.

# Starting a Script

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

- Creating ADSL
- Creating ADCE
- Creating ADFACE
- Creating ADIS

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

    library(admiral)

    use_ad_template(
      adam_name = "adce",
      save_path = "./ad_adce.R",
      package = "admiralvaccine"
    )

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

    list_all_templates(package = "admiralvaccine")
    #> Existing ADaM templates in package 'admiralvaccine':
    #> • ADCE
    #> • ADFACE
    #> • ADIS
    #> • ADSL

# Support

Support is provided via the admiral Slack channel.