Add example to convert file formats and changing keypoints

Lauraschwarz commented 2 months ago

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.

[ ] Bug fix
[x] Addition of a new feature
[ ] Other

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:

[x] The code has been tested locally
[x] The documentation has been updated to reflect any changes
[x] The code has been formatted with pre-commit

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 99.77%. Comparing base (b399ce0) to head (991ba1d).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #304 +/- ## ======================================= Coverage 99.77% 99.77% ======================================= Files 15 15 Lines 909 909 ======================================= Hits 907 907 Misses 2 2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.