-
Notifications
You must be signed in to change notification settings - Fork 14
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
General comments, text and documentation+ curiosity #69
Comments
Thanks! I have started working on installation and quick-start sections of the long-form documentation. Regarding your question: MIRP currently does not allow for computing radiomics feature maps. I agree it would be interesting. Creating an implementation that performs well will likely take some time and may require translating parts of the code to C or Cython. It is not something I plan to do anytime soon. |
@theanega and @alexzwanenburg, just on point 2: I believe that the four citations @theanega refers to are narrative in-text citations whereas the others are parenthetical. It is common to include both formats in a paper. See this APA Style and Grammar Guidelines webpage. I don't think any correction is needed here. |
Aim is to transition quick_start.rst into the notebook and create a working example.
General - great job and thanks!
First of all, huge congrats for the quality of the submitted project and for advancing radiomics research. I mean this not only with the MIRP package but also IBSI, IBSI2, etc. I always enjoy your papers. As a potential future user, I particularly appreciate the implementation of the fixed_bin_size_puradiomics feature. By extending MIRP to support non-IBSI compliant implementations, you are enabling other users to use MIRP to validate a wider range of radiomics results. This was a necessary and valuable addition to the field.
Text - minor correction:
Second paragraph of the Statement of need has 4 in-text citations that do not follow the same format as the others.
Documentation - good to go for now but some areas could benefit from extended content/additional clarifications and examples in the future...
Welcome page could be made more engaging and inviting to attract new users. For instance, you could add the statement of need, a section highlighting key features of MIRP and a table of contents. Even a brief section of "what is radiomics?", which could help make the documentation more compelling. Some documentation packages seem to have put a lot of effort into creating an attractive and informative welcome experience and I feel like this benefits adoption. Example (perhaps a bit too much but really fun): https://fusilli.readthedocs.io/en/latest/introduction.html,over 100 stars in a couple of weeks.
I would add an installation page "how to install"
Would add a quick start script similar to https://fusilli.readthedocs.io/en/latest/quick_start.html
Image Processing Settings
Feature computation settings:
Image interpolation settings:
Image transformation settings:
Process image and compute quantitative image features
Add also the guide for contributors (currently only in gitub repo)
In the future I would also add "release notes" and FAQs pages.
I would include somewhere the lessons learned from Appendix S8 of the IBSI2 paper (https://doi.org/10.1148/radiol.231319) in the MIRP documentation. These lessons seem highly relevant to the radiomics community, and their current limited accessibility could be improved by including them.
Curiosity/question:
The text was updated successfully, but these errors were encountered: