Skip to content

Commit

Permalink
adding docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
jeandut committed Oct 17, 2023
1 parent 8fbcc2f commit 9ddd874
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion pydeseq2/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,12 @@ def build_design_matrix(
design_factors : str or list
Name of the columns of metadata to be used as design_matrix variables.
(default: ``"condition"``).
(default: ``"condition"``). One can also use the 'formula' syntax:
~x+y+x:y. For interactions terms use either the formula syntax as a string
or use x:y in the name with the name of two columns to combine.
If one or more of the columns to combine are contiinuous the resulting
column will be a multiplication term by term.
ref_level : dict or None
An optional list of two strings of the form ``["factor", "ref_level"]``
Expand Down

0 comments on commit 9ddd874

Please sign in to comment.