-
Notifications
You must be signed in to change notification settings - Fork 10
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 example to convert file formats and changing keypoints #304
Add example to convert file formats and changing keypoints #304
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #304 +/- ##
=======================================
Coverage 99.77% 99.77%
=======================================
Files 15 15
Lines 909 909
=======================================
Hits 907 907
Misses 2 2 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot for you contribution @Lauraschwarz!
Don't be alarmed by the number of comments, most of them have to do with enforcing a consistent style across our examples, and as such may appear nitpicky. But stylistic consistency pays off for the readers (I hope).
Let me know if you have questions regarding my suggestions, or if you need help with their implementation.
…tion into three separate operations.
…dded additional example function to run on fpath
added Niko's suggestions, implementing comments Co-authored-by: Niko Sirmpilatze <[email protected]>
396420a
to
991ba1d
Compare
Quality Gate passedIssues Measures |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot for implementing my feedback @Lauraschwarz!
I've taken the liberty of putting some finishing touches:
- moved some contents between notebook cells, for a more uniform structure
- used variable names and imports similar to elsewhere in movement docs
- slightly edited language (e.g. tenses) to make it consistent throughout
- added hyperlinks to relevant pages of the movement and xarray docs (for further reading)
- I clarified the function of the
split_individuals
argument for saving files. - In the final
convert_all()
function, I replacedreturn
withcontinue
in the case thatdest_path
already exists. That's because I think your intention is to skip that particular file in the loop, not to exit the entire function for the sake of 1 file. - I added a default thumbnail image for examples such as yours, which lack a plot (otherwise the first plot is automatically used as a thumbnail).
- I rebased the PR to
main
to ensure nothing it outdated.
Assuming all tests pass, I will merge this PR.
When we make the next PyPI release, this example will be automatically published on our website 🎉 . Thanks for your hard work.
6c32608
Before submitting a pull request (PR), please read the contributing guide.
Please fill out as much of this template as you can, but if you have any problems or questions, just leave a comment and we will help out :)
Description
What is this PR
this PR adds functions to rename, delete and re-order keypoints in your pose-estimation files.
Why is this PR needed?
It just adds flexibility to your pose-estimation files. sometimes you would like to rename or delete keypoints without having to go through the entire prediction process of DLC or SLEAP
What does this PR do?
it adds functions to rename, re-order and delete keypoints in you post processing
How has this PR been tested?
locally on my own data.
Please explain how any new code has been tested, and how you have ensured that no existing functionality has changed.
it is additional functionality and does not change any of the functionality that currently exists.
Is this a breaking change?
no
Does this PR require an update to the documentation?
no (it is in itself an update to the docs)
Checklist: