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

Update documentation #233

Merged
merged 5 commits into from
Apr 24, 2017
Merged

Conversation

JoostJM
Copy link
Collaborator

@JoostJM JoostJM commented Apr 5, 2017

Change style of feature documentation to be more easily adaptable for a article supplement.

Update ReadMe files in ROOT and in ROOT\data.

Add additional FAQs.

Remove the SumVariance feature and rename SumVariance2 to SumVariance. This is due to the fact that the original SumVariance in PyRadiomics was based on a literal interpretation of the definition in the Haralick paper, where it is possible that the reference to entropy instead of average was a typo (as in f7, it referred to f8 instead of f6).

@JoostJM
Copy link
Collaborator Author

JoostJM commented Apr 5, 2017

N.B. This also includes a change to the baseline (GLCM)

@JoostJM JoostJM force-pushed the update-documentation branch from 5a6d10c to da0eef6 Compare April 21, 2017 09:14
@JoostJM
Copy link
Collaborator Author

JoostJM commented Apr 21, 2017

I split the commit (put the removal of SumVariance in a separate commit), as this constitutes a change to the baseline and therefore not just a documentation change.

JoostJM added 5 commits April 24, 2017 11:28
Change style of feature documentation to be more easily adaptable for a article supplement.

Update ReadMe files in `ROOT` and in `ROOT\data`.

Add additional FAQs.
Remove the SumVariance feature and rename SumVariance2 to SumVariance. This is due to the fact that the original SumVariance in PyRadiomics was based on a literal interpretation of the definition in the Haralick paper, where it is possible that the reference to entropy instead of average was a typo (as in f7, it referred to f8 instead of f6).
In the installation intstructions on the README, index and installation sections, python installation commands used `sudo`, however this is not recommended and PyRadiomics should work with normal user level privileges. Therefore, remove the `sudo` command from the Linux command lines.
Reflects recent changes to features.
@JoostJM JoostJM force-pushed the update-documentation branch from 4200869 to 209b4ab Compare April 24, 2017 09:30
@JoostJM JoostJM merged commit 0d350fc into AIM-Harvard:master Apr 24, 2017
@JoostJM JoostJM mentioned this pull request Apr 25, 2017
@JoostJM JoostJM deleted the update-documentation branch April 25, 2017 14:49
@JoostJM JoostJM mentioned this pull request Sep 5, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant