Quick Assistance #53 #58
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
acsenrafilho
left a comment
acsenrafilho
left a comment
There was a problem hiding this comment.
Thank you very much for the contribution!
I made some commentaries to fix general problema with the methods import and usage.
Please use the documentation and code docstring as reference to make the modifications.
Thank you again for helping this project!
| ## Load and Save an ASL Image | ||
|
|
||
| ```python | ||
| from asltk.io import load_asl, save_asl |
There was a problem hiding this comment.
please, check the asltk documentation reference to make the correct import and function usage.
| --- | ||
| ## Modify Parameters of an ASL Image | ||
| ```python | ||
| from asltk.io import load_asl |
There was a problem hiding this comment.
please, check the asltk documentation reference to make the correct import and function usage.
| from asltk.io import load_asl | ||
|
|
||
| asl_data = load_asl("image.nii.gz") | ||
| asl_data.pld_values = [1.5] # Update post-label delay |
There was a problem hiding this comment.
a sugestion is to provide more data in the list, even though that new data is randomly choosen.
It is better to assist new users to understand that the ld, pld, and so on, are actually python lists of float values
| --- | ||
| ## Copy an ASL Dataset | ||
| ```python | ||
| from copy import deepcopy |
There was a problem hiding this comment.
please, check the asltk documentation reference to make the correct import and function usage.
There is a copy method in the ASLData class
| ## Create T1-BLG Map from MultiTE-ASL | ||
| ```python | ||
| from asltk.io import load_asl | ||
| from asltk.multite import generate_t1blgm_map |
There was a problem hiding this comment.
please, check the asltk documentation reference to make the correct import and function usage.
This is not he actual way to call the object. Please, revise it
| --- | ||
| ## Modify Parameters Before Reconstruction | ||
| ```python | ||
| from asltk.io import load_asl |
There was a problem hiding this comment.
please, check the asltk documentation reference to make the correct import and function usage.
Same commentary as above
| @@ -0,0 +1,70 @@ | |||
| # **Quick Assistance** | |||
There was a problem hiding this comment.
It is also needed to be allocated the new quick_assistance.md file into the mkdocs.yml configuration.
Please modify the configuration to propagate the documentation correctly.
2 participants
Pull Request: Add "Quick Assistance" Section to Docs and README #53
Description
This PR addresses Issue #53 by introducing a new "Quick Assistance" section designed to help new users quickly perform common tasks with asltk.
Changes Included
1. New Documentation Page
2. Updated README
3. MkDocs Configuration
Why This Matters
This update provides:
Related
Closes #53
Docs link: Quick Assistance on ReadTheDocs
@acsenrafilho Please check, review and merge
Thank You