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

Restructure folders #254

Merged
merged 2 commits into from May 15, 2017
Merged

Conversation

JoostJM
Copy link
Collaborator

@JoostJM JoostJM commented May 9, 2017

Restructure directory tree to make a better distinction between additional scripts for special uses in PyRadiomics (bin folder) and examples (examples folder)

switch testing of notebooks to make use of the Hello* and PyRadiomicsExample Notebooks, which more extensively use the different parts of the toolbox and represent multiple ways in which the toolbox can be used.

Restructure folders to better catalog the scripts and jupyter notebooks not part of the pyradiomics core code.
Example scripts, notebooks and example parameter files are now stored in the directory tree under `examples`.
The `bin` folder now only contains some scripts useful for developers and for specific use cases. These include a script to generate and add a baseline for a new featureclass and a script to resample a mask to the image geometry.

Update the references to these files where necessary in the documentation.
@JoostJM
Copy link
Collaborator Author

JoostJM commented May 10, 2017

@Radiomics/developers Can this be merged? It also fixes a bug in the circleci testing, so I want to merge this PR first.

@@ -377,7 +377,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython2",
"version": "2.7.12"
"version": "2.7.11"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if this is needed.

Copy link
Collaborator Author

@JoostJM JoostJM May 11, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, but that is changed automatically if you run the notebooks. I'll revert this change.

@jcfr
Copy link
Collaborator

jcfr commented May 10, 2017

Would it make sense to have:

examples/batchExamples -> examples/examples
examples/Notebooks -> examples/notebooks

and also:

batchProcessingPandas.py -> batchProcessingWithPandas.py
batchprocessing.py -> batchProcessing.py

Last, would it make sense to have all example in one folder ...

examples/helloFeatureClass.py
[...]
examples/helloFeatureClassWithSettings.py  # This is where the exampleSettings would be used ... 
[...]
examples/batchProcessingWithPandas.py
examples/batchProcessing.py
...

@fedorov
Copy link
Collaborator

fedorov commented May 10, 2017

Is there a good reason not to have notebooks as a top-level folder?

@fedorov
Copy link
Collaborator

fedorov commented May 10, 2017

Overall, I don't have any major concerns, feel free to merge!

@JoostJM
Copy link
Collaborator Author

JoostJM commented May 10, 2017

@fedorov no particular reason, just a question of preference...
@jcfr, would it be better if the example settings are used with helloRadiomics. They are meamt to be used with the feature extractor...

@jcfr
Copy link
Collaborator

jcfr commented May 10, 2017

would it be better if the example settings are used with helloRadiomics. They are meamt to be used with the feature extractor...

Probably, something like helloRadiomicsWithSettings.py then.

I also wonder if the example should be numbered in the order they should be reviewed by a new user ..

0_helloFeatureClass.py
1_helloRadiomics.py
2_helloResampling.py

@JoostJM
Copy link
Collaborator Author

JoostJM commented May 10, 2017

In that case I would suggest to move helloFeatureClass should be moved to the back as it represents a non-standard use of pyradiomics

Update the config.yml to test the hello* notebooks and the PyRadiomicsExample.ipynb, which more extensively tests different parts of the toolbox and different ways the toolbox can be used.
@JoostJM
Copy link
Collaborator Author

JoostJM commented May 11, 2017

I restructured the folder, so that now notebooks is a separate top-level folder, and have one folder for all examples.

Seeing as the input CSV as it is structured for the batch examples is also the way it is structured for the batch script for the commandline, I moved the scripts showing how to build such a CSV from a dataset to the bin folder.

Moreover, I provided a test csv file to allow users to test the batch scripts using the test data included in the repository. This file is included with the examples.

Finally updated the notebooks some to better reflect recent changes.

@JoostJM
Copy link
Collaborator Author

JoostJM commented May 11, 2017

I also wonder if the example should be numbered in the order they should be reviewed by a new user

I did not number the examples, as only the helloRadiomics example would be an example that a new user would have to view first. All the other examples show a specific use of PyRadiomics, but are more or less equal to each other in terms of when a new user would use them.

@JoostJM JoostJM merged commit e047557 into AIM-Harvard:master May 15, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants