Skip to content
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

JOSS issue #85

Closed
drcandacemakedamoore opened this issue May 6, 2024 · 4 comments · Fixed by #86
Closed

JOSS issue #85

drcandacemakedamoore opened this issue May 6, 2024 · 4 comments · Fixed by #86
Labels
documentation Improvements or additions to documentation

Comments

@drcandacemakedamoore
Copy link

I ran through some examples, and I'm basically close to happy with the package now, but before signing off the most critical thing to me is actually not about the computing but the documentation. I may have missed it, but you need either to explicitly point to the IBSI reference value sheet so people can match up the variable names to your outputs or a clear easy to find table with what all your 192 outputs mean. In some cases it is obvious ie. someone without the IBSI sheet in hand will assume stat_kurt refers to kurtosis and stat_mean refers to a mean pixel or voxel value. In other cases ivh_v25 or ngl_gl_var_d1_a0.0_2d_fbn_n16, they will have no idea what this means . I actually would prefer you put a table in, because hyperlinks can go bad.

@drcandacemakedamoore drcandacemakedamoore added the documentation Improvements or additions to documentation label May 6, 2024
@alexzwanenburg
Copy link
Member

That's actually a really good point. I will start working on a table for features and filters and show what feature names mean.

@alexzwanenburg
Copy link
Member

Reopened for JOSS review.

@alexzwanenburg
Copy link
Member

I added a list here: https://oncoray.github.io/mirp/features_names.html

@drcandacemakedamoore
Copy link
Author

Looks good to me!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants