juaml/junifer
Watch
3
0
Fork
You've already forked junifer
 0
Code Issues 14 Pull requests 2 Packages Activity Actions

[ENH]: Introduce new onthefly sub-module for quick transforms for analyses #237

Merged
synchon merged 11 commits from feat/transform-module into main 2023-07-06 17:46:46 +00:00
Conversation 5 Commits 11 Files changed 10 +335 -1
synchon commented 2023-06-30 11:11:33 +00:00 (Migrated from github.com)
Copy link
  • description of feature/fix
  • tests added/passed
  • add an entry for the latest changes

This PR introduces new onthefly sub-module for performing quick transformation of stored data, for further analyses. It intentionally doesn't store the transformed data back as it's cheap to compute and only required for downstream work. For now, it only has one function read_transform() to be used with other third-party libraries (bctpy for now). The docstring of read_transform() provides enough information on using it and also warnings on when it can cause issues. Unit tests are included as well.

* [x] description of feature/fix * [x] tests added/passed * [x] add an entry for the latest changes This PR introduces new `onthefly` sub-module for performing quick transformation of stored data, for further analyses. It intentionally doesn't store the transformed data back as it's cheap to compute and only required for downstream work. For now, it only has one function `read_transform()` to be used with other third-party libraries (`bctpy` for now). The docstring of `read_transform()` provides enough information on using it and also warnings on when it can cause issues. Unit tests are included as well.
codecov[bot] commented 2023-06-30 11:12:10 +00:00 (Migrated from github.com)
Copy link

Codecov Report

Merging #237 (0e4782a) into main (602ea62) will increase coverage by 0.00%.
The diff coverage is 93.93%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #237   +/-   ##
=======================================
  Coverage   93.57%   93.57%           
=======================================
  Files          82       84    +2     
  Lines        3471     3504   +33     
  Branches      644      648    +4     
=======================================
+ Hits         3248     3279   +31     
- Misses        146      148    +2     
  Partials       77       77
Flag Coverage Δ
docs 100.00% <ø> (ø)
junifer 93.57% <93.93%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
junifer/__init__.py 100.00% <ø> (ø)
junifer/onthefly/read_transform.py 93.75% <93.75%> (ø)
junifer/onthefly/__init__.py 100.00% <100.00%> (ø)
## [Codecov](https://app.codecov.io/gh/juaml/junifer/pull/237?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) Report > Merging [#237](https://app.codecov.io/gh/juaml/junifer/pull/237?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) (0e4782a) into [main](https://app.codecov.io/gh/juaml/junifer/commit/602ea62f236e85261ed497a8b95de6f9aedb38b1?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) (602ea62) will **increase** coverage by `0.00%`. > The diff coverage is `93.93%`. [![Impacted file tree graph](https://app.codecov.io/gh/juaml/junifer/pull/237/graphs/tree.svg?width=650&height=150&src=pr&token=5H21JuZXMw&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml)](https://app.codecov.io/gh/juaml/junifer/pull/237?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) ```diff @@ Coverage Diff @@ ## main #237 +/- ## ======================================= Coverage 93.57% 93.57% ======================================= Files 82 84 +2 Lines 3471 3504 +33 Branches 644 648 +4 ======================================= + Hits 3248 3279 +31 - Misses 146 148 +2 Partials 77 77 ``` | Flag | Coverage Δ | | |---|---|---| | docs | `100.00% <ø> (ø)` | | | junifer | `93.57% <93.93%> (+<0.01%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://app.codecov.io/gh/juaml/junifer/pull/237?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) | Coverage Δ | | |---|---|---| | [junifer/\_\_init\_\_.py](https://app.codecov.io/gh/juaml/junifer/pull/237?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9fX2luaXRfXy5weQ==) | `100.00% <ø> (ø)` | | | [junifer/onthefly/read\_transform.py](https://app.codecov.io/gh/juaml/junifer/pull/237?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9vbnRoZWZseS9yZWFkX3RyYW5zZm9ybS5weQ==) | `93.75% <93.75%> (ø)` | | | [junifer/onthefly/\_\_init\_\_.py](https://app.codecov.io/gh/juaml/junifer/pull/237?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9vbnRoZWZseS9fX2luaXRfXy5weQ==) | `100.00% <100.00%> (ø)` | |
synchon commented 2023-06-30 11:23:08 +00:00 (Migrated from github.com)
Copy link

Should be merged after #236 .

Should be merged after #236 .
fraimondo (Migrated from github.com) reviewed 2023-07-03 09:03:48 +00:00
fraimondo (Migrated from github.com) left a comment
Copy link

This needs #236 to be merged first. There are changes related to that PR.

This needs #236 to be merged first. There are changes related to that PR.
pyproject.toml
@ -73,6 +73,7 @@ docs = [
"towncrier==22.12.0",
fraimondo (Migrated from github.com) commented 2023-07-03 09:03:18 +00:00
Copy link

shouldn't this be onthefly?

shouldn't this be `onthefly`?
synchon (Migrated from github.com) reviewed 2023-07-03 09:53:57 +00:00
pyproject.toml
@ -73,6 +73,7 @@ docs = [
"towncrier==22.12.0",
synchon (Migrated from github.com) commented 2023-07-03 09:53:56 +00:00
Copy link

I had kept it as it is, but can change it.

I had kept it as it is, but can change it.
fraimondo (Migrated from github.com) approved these changes 2023-07-06 15:18:26 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
fraimondo
Labels
Clear labels   
CRITICAL
High Priority Issue

  
Stale

   
WIP
Work in progress

  
bug
Something isn't working

  
concept
Design/Implementation concepts

  
coordinate
Issues or pull requests related to coordinates (ROIs)

  
dataset
Issues or pull requests related to datagrabbers or datasets

  
dependencies
Pull requests that update a dependency file

  
documentation
Improvements or additions to documentation

  
duplicate
This issue or pull request already exists

  
enhancement
New feature or request

  
github_actions
Pull requests that update GitHub Actions code

  
good first issue
Good for newcomers

  
help wanted
Extra attention is needed

  
invalid
This doesn't seem right

  
maintenance
Issues or pull requests related to maintenance

  
maps
Issues or pull requests related to maps (probabilistic atlases)

  
marker
Issues or pull requests related to markers

  
mask
Issues or pull requests related to masks

  
on hold
Issue waiting on other issue(s)

  
parcellation
Issues or pull requests related to parcellations (deterministic atlases)

  
preprocess
Issues or pull requests related to preprocessors

  
question
Further information is requested

  
ready
Pull request is ready for review and merge

  
storage
Issues or pull requests related to marker storage or retrieval

  
template-space
Issues or pull requests related to template spaces

  
triage
New issues waiting to be reviewed

  
wontfix
This will not be worked on

No labels
CRITICAL
Stale
WIP
bug
concept
coordinate
dataset
dependencies
documentation
duplicate
enhancement
github_actions
good first issue
help wanted
invalid
maintenance
maps
marker
mask
on hold
parcellation
preprocess
question
ready
storage
template-space
triage
wontfix
Milestone
Clear milestone
No items
No milestone
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
juaml/junifer!237
No description provided.