search

zmjones / edarf

exploratory data analysis using random forests
MIT License
68 stars 11 forks source link

readme #51

Closed PhilippPro closed 8 years ago

PhilippPro commented 8 years ago

You have two times extract_proximity in the readme. Moreover you have randomforest_distance, but the function is randomforest_dist. You do not mention randomforest_dist in the paper, but maybe this is not a problem. I really do not know what happens in randomforest_dist, you could add a reference or better explanation in the help. Also references in the help of the other functions.

Sorry for being very critical, but I think this could really improve the documentation.

zmjones commented 8 years ago

Ha no problem. Totally fair. Criticism is the point. Will fix this and the other issue when I get to the office. Thanks again for reviewing this. On Wed, Oct 19, 2016 at 7:50 AM Philipp Probst notifications@github.com wrote:

You have two times extract_proximity in the readme. Moreover you have randomforest_distance, but the function is randomforest_dist. You do not mention randomforest_dist in the paper, but maybe this is not a problem. I really do not know what happens in randomforest_dist, you could add a reference or better explanation in the help. Also references in the help of the other functions.

Sorry for being very critical, but I think this could really improve the documentation.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/zmjones/edarf/issues/51, or mute the thread https://github.com/notifications/unsubscribe-auth/ABEBhc49dWMz_O7SPxGPLEgj7fDxW21Nks5q1gQPgaJpZM4Ka4Fg .

zmjones commented 8 years ago

I went ahead and removed it. I'll reimplement later if needed.

PhilippPro commented 8 years ago
zmjones commented 8 years ago

do you mean references to articles? or links to the packages?

PhilippPro commented 8 years ago

References to articles.

E.g. if you look at ?randomForest you see the reference section:

References

Breiman, L. (2001), Random Forests, Machine Learning 45(1), 5-32.

Breiman, L (2002), “Manual On Setting Up, Using, And Understanding Random Forests V3.1”, https://www.stat.berkeley.edu/~breiman/Using_random_forests_V3.1.pdf.

zmjones commented 8 years ago

ok did those things. thanks