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

DOC improve the "Getting Started" notebook from the example gallery #56

Merged
merged 17 commits into from
Jan 23, 2023

Conversation

BorisMuzellec
Copy link
Collaborator

@BorisMuzellec BorisMuzellec commented Jan 19, 2023

The aim of this PR is to improve the Getting Started notebook from the example gallery.

This example should be sufficiently self-contained to allow new users to get started with PyDESeq2 after reading it, whether they are interested in single or multi-factor analysis.

Further explanations of the intermediary steps that are wrapped in DeseqDataSet's deseq2() and DeseqStats's summary() methods will be deferred to another example, to write later.

@BorisMuzellec BorisMuzellec changed the title Improve the "Getting Started" notebook from the example gallery DOC improve the "Getting Started" notebook from the example gallery Jan 19, 2023
@BorisMuzellec BorisMuzellec marked this pull request as ready for review January 20, 2023 16:08
Copy link
Collaborator

@maikia maikia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice and through example! Thanks @BorisMuzellec
One more thing to think about for the future would be to have a picture to this example.

examples/plot_minimal_pydeseq2_pipeline.py Outdated Show resolved Hide resolved
examples/plot_minimal_pydeseq2_pipeline.py Outdated Show resolved Hide resolved
examples/plot_minimal_pydeseq2_pipeline.py Outdated Show resolved Hide resolved
examples/plot_minimal_pydeseq2_pipeline.py Outdated Show resolved Hide resolved
examples/plot_minimal_pydeseq2_pipeline.py Show resolved Hide resolved
examples/plot_minimal_pydeseq2_pipeline.py Outdated Show resolved Hide resolved
examples/plot_minimal_pydeseq2_pipeline.py Outdated Show resolved Hide resolved
@BorisMuzellec
Copy link
Collaborator Author

Thanks a lot @maikia for the review!
I've answered your comments and I'm going to merge this PR.
I agree that adding a figure would be nice – maybe once we have some plotting functions implemented?

@BorisMuzellec BorisMuzellec merged commit 17535c1 into main Jan 23, 2023
@BorisMuzellec BorisMuzellec deleted the improve_getting_started branch January 23, 2023 10:02
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

Successfully merging this pull request may close these issues.

2 participants