---
title: Working with ADaM Datasets
slug: ryze/working-with-adam-datasets
description: Learn how to effectively manage and create analysis datasets using the CDISC Analysis Data Model (ADaM) principles. Discover the importance of traceability from CRF to SDTM and from SDTM to ADaM datasets through pre-configured links. Explore various optio
createdAt: 2023-08-31T10:45:33.021Z
---

Analysis datasets are designed to meet the goals and fundamental principles of the CDISC Analysis Data Model (ADaM) and provide analysis-ready datasets. You can configure and format assets (for example, derived Variable assets) in line with the CDISC ADaM principles. Ryze also provides published standards that can be used to create ADaM datasets. These published standards have pre-configured traceability to SDTM and provide a good starting point for building analysis datasets. 

In practice, ADaM datasets can be much larger and include more variables than SDTM. In this guide we’ll look at how ryze helps manage ADaM Datasets in line with CDISC guidelines.

## Traceability

Ryze provides published ADaM datasets that can be imported into your standard or study. These published datasets have pre-configured links to SDTM. For example, an ADaM variable might have an *Origin\:Predecessor* property that points to an SDTM variable identifier such as DM.AGE. ryze helps provide clear traceability from CRF to SDTM and from SDTM to ADaM datasets.

## Analysis Dataset Creation

When creating an analysis dataset, you’ll want to include analysis variables and classes such as ADSL, BDS, ODS and so on. Published standards include these classes already and provide things like a prefixed identifier (e.g. BDS.STUDYID) and Origin properties but you can manually build your own variables. The following options are available when working with ADaM datasets:

**Use the Published ADaM Standard**

Published ADaM datasets have pre-configured links to SDTM as well as provide imputed and derived variables, so they provide a good starting point for building ADaM datasets. You can also extend ADaM datasets by using cloning functionality to clone individual variables; these cloned variables retain links to SDTM variables. For example, if you want to extend a grouped or pooled variable such as, *Pooled Age Group y (N),*&#x63;loning functionality can be used.

**Creating Other Classes**

Ryze provides the following ADaM dataset classes by default:

- ADSL
- BDS
- OCCDS
- ADTTE 

These datasets include the applicable identifier prefix, for example, OCCDS.STUDYID. 

You can also create other Classes and apply identifier prefixes by cloning the published ADaM content. You must then change the identifier at the variable level, for example, BDS.STUDYID to ADVS.STUDYID.

**Clone Variables from SDTM and Modify**

If you want to create a specific ADaM variable that already exists in your repository as an SDTM variable, you can import the SDTM variable as a clone and change the *Origin&#x20;*&#x70;roperty. This allows you to keep the link to the SDTM variable as well as quickly create an ADaM variable. When cloning variables from SDTM, you must set the origin property to *Predecessor&#x20;*&#x61;nd add the Object Identifier (OID) of the source SDTM variable to the Description field.  

**Create Variables Manually**

Alternatively, you can create ADaM variables and manually link them to SDTM variables in another standard. This is not recommended if you are creating copies of SDTM variables and the cloning method described previously should be used.

## Analysis Dataset Generation 

Analysis Result Metadata (ARM) is used to tie together ADaM datasets, outcome tables, and documentation that describes the analysis.&#x20;

:::hint{type="info"}
The purpose of the Define-XML Analysis Results Metadata extension is to support the interchange of CDISC ADaM key Analysis Results Metadata for clinical research applications in a machine-readable format.
:::

Ryze allows you to generate the Define-XML with ARM and there are two assets that are used to manage ARM: **Results display** and **Analysis result**. 

**Results Display**

This asset describes which result is displayed, for example which outcome table is in view. It can include a description of the outcome as well as a reference to the Analysis Result.

**Analysis Result**

This asset describes the key result or exploratory outcome measure (Analysis Purpose). Analysis result describes which variables are used for the analysis (Analysis Datasets) and includes a description of what is displayed (Description). These assets can also include external Documents such as the Statistical Analysis Plan (Document) and links to programming code used to derive the primary outcome measure (Code).

## Working with ARM

Analysis Results Metadata (ARM) provides traceability for an analysis result to the specific ADaM data used as input, it also provides information about the analysis method used and the reason the analysis was performed. Since ARM describes a result that relates to ADaM Datasets, before specifying ARM, the ADaM dataset metadata must be added.

![](https://api.archbee.com/api/optimize/aRGXD44FysHcCUICvfsxc/APrd_Mf0uuuV_DVzFxrQM_image.png)

In the [specifications for ARM](https://www.cdisc.org/standards/foundational/define-xml/analysis-results-metadata-arm-v1-0-define-xml-v2-0), CDISC outlines the key components as follows:

- Analysis Display metadata definitions
  - Analysis Result metadata definitions
  - Analysis parameter(s)
    - Analysis dataset(s)
      - Analysis variable(s)
      - Selection criteria
    - Documentation
    -      Programming statements

If you have an asset group with ADaM Datasets, you can create a Result Display using the following workflow:

1. Create the Results Display:
   1. Enter details for Label, Name, Identifier and Description
   2. Click **Validate**
2. Create Document:
   The result display has documentation provided to further describe the analysis. **Description&#x20;**&#x70;rovides a short local text description, and a **Document Reference** is used to link to an external document (e.g. PDF) with page references.
   Click **Create Document**
   1. Enter details for Label, Name and Identifier
   2. To attach an external document, click on the upload icon under **File name**.&#x20;
   3. Add **Page reference**. When a document is attached, you can create one or more page references. The references can cite page numbers, a page range or named destinations within the document.&#x20;
   4. \[Optional] Enter some descriptive text.
   5. Click **Validate**.
3. Create Analysis Result:
   1. Click **Create analysis result**
   2. Enter details for Label, Name, Identifier, Analysis reason, Analysis Purpose.&#x20;
   3. Add Code. The Analysis Result captures the programming code used to derive the result. This can be expressed in two ways:
      - Direct code entry into the “Code” fields **Code>Context&#x20;**&#x61;nd **Code>Expression&#x20;**
      - an External Document reference, linking to code for example in a PDF file.
   4. Click **Validate**.
4. Associate Datasets, in this step you reference the ADaM Dataset providing the source data:
   1. Click **Associate datasets&#x20;**&#x61;nd select the source dataset
   2. Under **Selection criteria**, click **Add criteria**.&#x20;
   3. Add a Label, Name and Identifier.&#x20;
   4. Add a **Where&#x20;**&#x63;lause, select a variable within the associated dataset, then specify a selection criteria using the Comparator and Value. You can open the source dataset in another tab for reference. You can add more than one Selection Criteria.
   5. Add a **Parameter**. When the dataset has been associated, it is possible to link to a ValueList Item using the "**Parameter**" property.
   6. Add Analysis documentation. For each result display, a separate documentation link can be created, giving a local description and external document reference.
5. Export to Define-XML - The [Exports](https://docs.formedix.com/ryze/exports) tab is used to export to Define-XML. Exports must be generated at Asset Group level.&#x20;

:::Iframe{iframeHeight="0" code="<div style=&#x22;padding:75% 0 0 0;position:relative;&#x22;><iframe src=&#x22;https://player.vimeo.com/video/900152702?h=da4e7e510f&#x26;amp;badge=0&#x26;amp;autopause=0&#x26;amp;player_id=0&#x26;amp;app_id=58479&#x22; frameborder=&#x22;0&#x22; allow=&#x22;autoplay; fullscreen; picture-in-picture&#x22; style=&#x22;position:absolute;top:0;left:0;width:100%;height:100%;&#x22; title=&#x22;working with ARM&#x22;></iframe></div><script src=&#x22;https://player.vimeo.com/api/player.js&#x22;></script><!-- <p>paste iframe code here</p> -->"}

:::











