Skip to content

Conversation

@d33bs
Copy link
Member

@d33bs d33bs commented May 7, 2025

Description

This PR adds a "path reporter" to help observe various challenges @jenna-tomkinson had mentioned appear within image datasets. This doesn't cover all the issues and instead is just a start towards this (the complexity of the others might warrant a separate or multiple other PR's).

References #28

What kind of change(s) are included?

  • Documentation (changes docs or other related content)
  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (these changes would cause existing functionality to not work as expected).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have searched for existing content to ensure this is not a duplicate.
  • I have performed a self-review of these additions (including spelling, grammar, and related).
  • These changes pass all pre-commit checks.
  • I have added comments to my code to help provide understanding
  • I have added a test which covers the code changes found within this PR
  • I have deleted all non-relevant text in this pull request template.

@d33bs d33bs requested a review from jenna-tomkinson May 7, 2025 18:12
@d33bs d33bs marked this pull request as ready for review May 8, 2025 12:16
@d33bs d33bs changed the title Add path_report capability to help observe file and directory challenges Add path_report capability to help observe file and directory challenges May 8, 2025
Copy link
Member

@jenna-tomkinson jenna-tomkinson left a comment

Choose a reason for hiding this comment

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

LGTM! All these tests are very good and I think the only other comment I have is that in the documentation it should be noted that these tests work best when the images are in a certain format (e.g., per plate, each folder is a individual well and FOV combo).

Co-Authored-By: Jenna Tomkinson <107513215+jenna-tomkinson@users.noreply.github.com>
@d33bs
Copy link
Member Author

d33bs commented May 20, 2025

Thanks @jenna-tomkinson !

LGTM! All these tests are very good and I think the only other comment I have is that in the documentation it should be noted that these tests work best when the images are in a certain format (e.g., per plate, each folder is a individual well and FOV combo).

Thanks for these thoughts - I'm going to leave the documentation as-is for now to keep this flexible to how things might develop. Generally my hope is that this can work for either (or any) case based on how we configure things. I think #45 might be useful when it comes to this - among other solutions.

@d33bs d33bs merged commit 0606357 into WayScience:main May 20, 2025
5 checks passed
@d33bs d33bs deleted the path-reporter branch May 20, 2025 19:00
MikeLippincott pushed a commit to MikeLippincott/nViz that referenced this pull request Sep 29, 2025
…enges (WayScience#42)

* Create check.py

* path report capabilities

* linting

* [pre-commit.ci lite] apply automatic fixes

* remove pull_request set of testion actions

* Update .pre-commit-config.yaml

* Update .pre-commit-config.yaml

* use pull request src instead of target for chkout

* add debug for actions

* remove debug

* update to avoid coverage discrepancies

* Update coverage-badge.svg

* move to macos for pre-commit checks

* linting

* ignore tests for coverage

* remove coverage reporting

* remove shellcheck because of docker

* add path reporter to cli

* update for return code expectations

* add complete test data

* update for tests and readd coverage just in case

* test locally

* Update run-tests.yml

* Update coverage-badge.svg

* Update coverage-badge.svg

* readd coverage

Co-Authored-By: Jenna Tomkinson <107513215+jenna-tomkinson@users.noreply.github.com>

* Update .pre-commit-config.yaml

---------

Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
Co-authored-by: Jenna Tomkinson <107513215+jenna-tomkinson@users.noreply.github.com>
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