Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvement for DeseqDataSet documentation #316

Open
ozanozisik opened this issue Sep 17, 2024 · 1 comment
Open

Improvement for DeseqDataSet documentation #316

ozanozisik opened this issue Sep 17, 2024 · 1 comment

Comments

@ozanozisik
Copy link

In DeseqDataSet documentation, ref_level is described as below:

ref_level : list or None
An optional list of two strings of the form ["factor", "test_level"]
specifying the factor of interest and the reference (control) level against which
we're testing, e.g. ["condition", "A"]. (default: None).

Use of "test_level" in the example while requiring reference level is confusing. It will be better if the example is ["factor", "ref_level"] (like in the description of build_design_matrix) or ["factor", "reference_level"].

@BorisMuzellec
Copy link
Collaborator

Hi @ozanozisik, thanks for the suggestion! Feel free to open a PR :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants