Skip to main content

Analysis properties

We recommend you define analysis properties in your analyses/ directory, which is illustrated in the analysis-paths configuration.

You can name these files whatever_you_want.yml, and nest them arbitrarily deeply in subfolders within the analyses/ or models/ directory.

analyses/<filename>.yml
version: 2

analyses:
- name: <analysis_name> # required
description: <markdown_string>
docs:
show: true | false
config:
tags: <string> | [<string>]
columns:
- name: <column_name>
description: <markdown_string>
- name: ... # declare properties of additional columns

- name: ... # declare properties of additional analyses

Changelog