Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pwwang committed Sep 30, 2020
1 parent 7b1371c commit 9b3c9f4
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/formulas.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,17 @@ Formulas are composed of macros on both sides, which are connected by `'~'`. It
However, we don't support operators like it from `R`. So we only have `Y ~ X`, but not `Y ~ X1 + X2`. In order to implement this, we have to define a macro to add `X1` and `X2` up.

We have three types of macros:

1. `continuous`: extracts continues values from a variant, such as allele frequency, depth, etc.
2. `categorical`: extracts categorical values from a variant, such as variant type, genotype, etc.
3. `aggregation`: aggregates some values from a group of variants, such as mean of allele frequency from chromosome 1
3. `aggregation`: aggregates some values from a group of variants, such as mean of allele frequency from chromosome 1. You can also add a filter to aggregation by `COUNT(1, filter=AAF[0.05, 0.95], group=CHROM)`

See section `Macros` for details.

!!! Tip

If you have both aggregations for Y and X, you can omit the group for either. The one without group will automatically use the group that is specified to the other one.

## Predefined figure types for different combination of `Y` and `X`

|Y|X|default figure type|other available figure types|
Expand Down

0 comments on commit 9b3c9f4

Please sign in to comment.