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

Rl/add motility analysis notebook #18

Merged
merged 28 commits into from
Jul 12, 2024
Merged

Conversation

lanery
Copy link
Collaborator

@lanery lanery commented Jul 5, 2024

This PR makes some headway towards finalizing the repo for release with the upcoming pub "A high-throughput imaging assay for phenotyping unicellular swimming", which is currently in review.

Main changes are

PR checklist

  • Tag the issue(s) or milestones this PR fixes (e.g. Fixes #123, Resolves #456).
  • Describe the changes you've made.
  • If you've added new functionality, make sure that the documentation is updated accordingly.
  • If you encountered bugs or features that you won't address, but should be addressed eventually, create new issues for them.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@lanery lanery requested a review from keithchev July 5, 2024 23:00
Copy link
Member

@keithchev keithchev left a comment

Choose a reason for hiding this comment

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

Looks good! The notebooks look clear and well-documented to me. I agree that a better name for the 2_Quality-Control notebook could be good. I would vote for something really specific and explicit like 2_check-temporal-variation-in-motility-metrics.

- rename notebook 2 based off Keith's suggestion from code review on #18
- surprising (to me at least) that switching upper case to lower case does not get flagged as a change so adding a `_` to make the switch to lower case for notebook 1
- also add placeholder doi link for pub
@lanery lanery merged commit a077f21 into main Jul 12, 2024
1 check passed
@lanery lanery deleted the rl/add-motility-analysis-notebook branch July 12, 2024 17:05
@lanery lanery restored the rl/add-motility-analysis-notebook branch July 12, 2024 21:27
@lanery lanery deleted the rl/add-motility-analysis-notebook branch July 12, 2024 21:29
lanery added a commit that referenced this pull request Jul 31, 2024
* Create 2_Motility_Analysis_Pools.ipynb

* Update 1_Compute-Summary-Motility-Metrics.ipynb

add units to table and reformat a few cells.

* Update 2_Motility_Analysis_Pools.ipynb

subset of metrics for bivariate distributions

* fix legend

* fix legend

* Create 3_Scale-to-Pools.ipynb

* Create 4_PCA.ipynb

* update notebook formatting

* reduce subset of metrics

* rename notebooks

* update input directories for published dataset

* refactor: substrate --> vessel

* calculate angular change as a rolling average

* Create S1_Quality-Control.ipynb

* remove unused import

* Update S1_Quality-Control.ipynb

* change table style in docs

* Update 1_Compute-Summary-Motility-Metrics.ipynb

- add documentation
- move experimental parameters to ../data/experimental_parameters.json
- remove superfluous plot

* motility metrics for cc124 instead of cc1373

* Create experimental_parameters.json

* Create 2_Quality-Control.ipynb

* Delete 2_Analyze-Motility-in-Pools.ipynb

* Delete 3_Compare-Pools-vs-Wells.ipynb

* Delete 4_Perform-PCA.ipynb

* Delete S1_Quality-Control.ipynb

* linting: remove unused imports

* Rename notebooks

- rename notebook 2 based off Keith's suggestion from code review on #18
- surprising (to me at least) that switching upper case to lower case does not get flagged as a change so adding a `_` to make the switch to lower case for notebook 1
- also add placeholder doi link for pub

* finish notebook name changes (for now)

* Update README.md

* Update README.md

* start using arcadia-pycolor

* Update dev.yml

* refactor: "substrate" --> "vessel_type"

* minor change to plot layout

add `plt.tight_layout()` which throws a `UserWarning` for some reason, so suppress that warning

* add `annotate_statistical_significance`

Add function for measuring and annotating results of a stats test to a plot. Includes a function for mapping P values to number of asterisks for the annotation.

* Create 3_motility-analysis-in-pools.ipynb

* add `inner_kws` arg to violinplot

* Delete plotting_pools.py

functions no longer used

* Update 3_motility-analysis-in-pools.ipynb

* Update 3_motility-analysis-in-pools.ipynb

* Create 4_compare-motility-in-pools-vs-wells.ipynb

Add notebook for comparing pools vs wells. Used for Figure 7 in the pub.

* add plots to results

* Update 3_motility-analysis-in-pools.ipynb

* try to fix linting issue

* LINTTTTTT

* Update 3_motility-analysis-in-pools.ipynb

Bit of clean up in light of Dave's feedback on the pub. Removed what would have been Fig 6 (redundant) and updated documentation to match other notebooks.

* Update 3_motility-analysis-in-pools.ipynb

Correct ylabel and take stabs at linting issue

* move stats testing and annotations to separate module

* Update 4_compare-motility-in-pools-vs-wells.ipynb

Make use of functionality in `stats_testing` to clean up notebook

* Update 3_motility-analysis-in-pools.ipynb

Make use of functionality in `stats_testing` to clean up notebook

* Update 3_motility-analysis-in-pools.ipynb

caught linting issue before it caught me!

* update plots for pub figures

* Update 2_temporal-variation-in-motility-metrics.ipynb

Remove axis grid lines.

* Update 2_temporal-variation-in-motility-metrics.ipynb

Remove superfluous catch warnings.

* Update figure-4.svg

remove grid lines

* Improvements from code review on #21

Add more documentation to notebooks 3 and 4.
Combine finding annotation coordinates for both orientations based on Keith's refactoring.
Miscellaneous refactoring and cleanup of `stats_testing.py`.

* remove unused warnings import
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.

Remove local file paths and improve notebook documentation
2 participants