jupyter notebook examples

[inkenbrandt]

It would be nice to have some examples of your scripts in use. I tried using this: http://nbviewer.jupyter.org/gist/phobson/9986377/ros.ipynb as an example, but it is different from what is in wqio. Would there be any way to add some tutorial notebooks for the various features of wqio, especially the ros?

[phobson]

@inkenbrandt this has been on my TODO list for a while, but I haven't gotten there yet.

It's a sad state of affairs when the tests are the best examples that you have :/
https://github.com/Geosyntec/wqio/blob/master/wqio/tests/test_ros.py#L614

Curious: Do you have some suggestions (besides a basic example there) for improving the docstring?
https://github.com/Geosyntec/wqio/blob/master/wqio/ros.py#L445

[inkenbrandt]

Actually, the docstring is really good. It made it possible for me to use the ROS function. If anything, I would add a little bit to the Returns section on what you get if as array is False. Also, at first I thought the array returned was in the same order as my input DataFrame.

[phobson]

@inkenbrandt I'm thinking I should remove the ability to return dataframes. I think a best if give the wrong impression about the nature of the imputation. Thoughts?

[inkenbrandt]

Maybe just be more explicit in the docs. The dataframe output with the intermediate steps really helped me understand what was happening. The array return by default helps prevent the wrong interpretation.