Skip to content

Commit ecb5a1e

Browse files
committed
docs: update docs
1 parent 5f91763 commit ecb5a1e

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/usage.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,10 +200,10 @@ contrasts:
200200
The necessary fields in order are:
201201

202202
- `formula` - A string representation of the model formula. It is used to build the design matrix.
203-
- `make_contrasts_str` - An explicit literal contrast string (e.g., "treatmenthND6 - treatmentmCherry") that is passed directly to [`limma::makeContrasts()`](https://rdrr.io/bioc/limma/man/makeContrasts.html) in `VARIANCEPARTITION_DREAM`. The parameter names must be syntactically valid variable names in R (see [`make.names`](https://stat.ethz.ch/R-manual/R-devel/library/base/html/make.names.html)). This field provides full control for complex designs. Requires `formula`.
203+
- `make_contrasts_str` - An explicit literal contrast string (e.g., "treatmenthND6 - treatmentmCherry") that is passed directly to [`limma::makeContrasts()`](https://rdrr.io/bioc/limma/man/makeContrasts.html) in `VARIANCEPARTITION_DREAM` and `LIMMA_DIFFERENTIAL`. The parameter names must be syntactically valid variable names in R (see [`make.names`](https://stat.ethz.ch/R-manual/R-devel/library/base/html/make.names.html)). This field provides full control for complex designs. Requires `formula`.
204204

205205
> [!WARNING]
206-
> Formula-based contrasts are currently only supported by `VARIANCEPARTITION_DREAM`. They **do not work** with tools like `DESEQ2` or base `LIMMA` implementations yet.
206+
> Formula-based contrasts are currently only supported by `VARIANCEPARTITION_DREAM` and `LIMMA_DIFFERENTIAL`. They **do not work** with tools like `DESEQ2` yet.
207207

208208
> [!NOTE]
209209
>
@@ -215,6 +215,7 @@ The necessary fields in order are:
215215
> - Then, `make_contrasts_str: "conditiontreated"` selects that coefficient for testing.
216216
>
217217
> This gives full control over the contrast definition but requires understanding of the model matrix.
218+
> Some downstream applications (e.g. `GSEA_GSEA`, `SHINYNGS_APP`) do not support formula-based contrasts as they require a `meta.variable`.
218219

219220
Beyond the basic one-factor comparison, the YAML contrasts format supports advanced experimental designs through the use of interaction terms and custom contrast strings. These are particularly useful in multifactorial experiments where the effect of one variable may depend on the level of another (e.g. genotype × treatment). To model an interaction between genotype and treatment, use a formula like `~ genotype * treatment`, which expands the yaml to:
220221

0 commit comments

Comments
 (0)