Get Started • admiralneuro

Introduction

As this is a package extension, if you are new to admiral then the best place to first start reading would be the Get Started page. 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 admiralneuro.

Creating Neuroscience ADaM Datasets

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

Creating ADAPET/ADTPET

admiralneuro 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 = "adapet",
  save_path = "./ad_adapet.R",
  package = "admiralneuro"
)
#> ✔ File ./ad_adapet.R has been created successfully

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

list_all_templates(package = "admiralneuro")
#> Existing ADaM templates in package 'admiralneuro':
#> • ADAPET
#> • ADTPET

Support

Support is provided via the admiral Slack channel. Additionally, please feel free to raise issues in our GitHub repository.