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

Add extensive documentation to the maldi-pipeline.ipynb notebook #30

Merged
merged 12 commits into from
Dec 17, 2024

Conversation

alex-l-kong
Copy link
Contributor

What is the purpose of this PR?

In anticipation of the presentation next week, the current MALDI extraction notebook is not formatted nor documented well. These notebooks need to be brought up to angelolab standards.

How did you implement your changes

  1. Sections are explicitly enumerated based on the specific task they perform.
  2. More detailed explanations have been provided about each process as well as what variables are being set.
  3. Certain cells have been combined to reduce clutter.

Remaining issues

Certain portions have been intentionally marked as WIP.

@alex-l-kong alex-l-kong self-assigned this Dec 11, 2024
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@coveralls
Copy link

coveralls commented Dec 11, 2024

Pull Request Test Coverage Report for Build 12381828443

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 97.445%

Totals Coverage Status
Change from base Build 11787590598: 0.0%
Covered Lines: 218
Relevant Lines: 219

💛 - Coveralls

@@ -4,14 +4,22 @@
"cell_type": "markdown",
Copy link
Contributor

@goterm goterm Dec 16, 2024

Choose a reason for hiding this comment

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

base_dir: specify file type extenstion (.d file or .imzml/.ibd?


Reply via ReviewNB

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@goterm just pushed new changes, do they address this?

@goterm goterm self-requested a review December 17, 2024 23:38
@alex-l-kong alex-l-kong merged commit 50eb163 into main Dec 17, 2024
3 of 4 checks passed
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.

3 participants