-
Notifications
You must be signed in to change notification settings - Fork 3
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 IO functions #3
Conversation
- assign reviewers (currently only kaitj and tkkuehn, can add more) - bump_version for semantic versioning - release to publish to pypi - test for linting and unit testing
- add .gitignore and update to ignore test generated files - add necessary libraries for working with afids - add test task to poe - setup type hints for functions - create exceptions.py to hold custom exceptions - create io.py for handling input/output methods - add dummy data (valid fcsv file, small nifti) - look into generating images in the future (look at nibabel for possible solutions?)
- take advantage of commit to fix spacing in PR template
55a1f03
to
2e40e20
Compare
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #3 +/- ##
========================================
Coverage ? 100.00%
========================================
Files ? 3
Lines ? 83
Branches ? 0
========================================
Hits ? 83
Misses ? 0
Partials ? 0
|
- add step to install package - save report as xml file in the workflow runner - add gha to post coverage report
This should be good for a first look. Still missing a few methods, but wanted to get something in so that we can configure the coverage as we want. It's currently set with a 5% threshold (e.g. it should fail if coverage falls below 95% - I think this is overall and not individual components but I might be wrong). |
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.
A couple of changes I think would be nice, and I didn't really look at the codecov stuff in depth at this point (I figure once we're getting reports for sure I can take a closer look)
- Renamed AFIDS_FIELDNAMES -> FCSV_FIELDNAMES - Update 'id' column fieldname to match slicer header - Use `usecols` in read_csv call - Change afid_coords from a numpy array to a composite strategy using hypothesis.extra.numpy.array - rm assignment of get_afid in test_invalid_num_get_afid - rm load_nii function and normalization (can use other packages like sklearn for this) - added fcsv template as static file under resources that can be imported rather than called in function
Proposed changes
Adds methods and tests for reading/writing nifti files and afids-associated files.
In addition, took advantage of this branch to make a minor change to the PR template to fix spacing.
Note: This is also being used as a test for
Codecov
Types of changes
What types of changes does your code introduce? Put an
x
in the boxes that applyChecklist
Put an
x
in the boxes that apply. You can also fill these out after creating the PR. If you are unsure about any of the choices, don't hesitate to ask!poe quality
taskNotes
All PRs will undergo the unit testing before being reviewed. You may be requested to explain or make additional changes before the PR is accepted.