How to Prepare Curated Alias

This guide explains how to prepare an alias file and use it as the Curated alias that will be displayed for a factor layer by default in CartoScope

Concepts

• Alias
• Alias Source

1. Prepare Your Alias File

Alias File Format

• The file must be a tab-separated file (.tsv) with one row per factor.
• It should contains two columns:
  • 1st column (header: either index or name): numeric factor indices.
  • 2nd column (header: alias): aliases names.

Example Alias File

index   alias
1   Tumor
2   Stroma
3   Immune

2. Link You Alias File in catalog.yaml

If you this alias file to by displayed for a factor layer of a dataset, define it in catalog.yaml.

Example catalog.yaml with Alias Files

In the example, we want to provide the curated_alias.tsv to the target_layer factor layer in the example_data dataset.

id: example_data
title: example_data
...
assets:
...
factors:
    - id: target_layer
    name: target_layer
    ...
    alias: curated_alias.tsv

In this setup:

• alias is the curated default alias table used as the Curated source.