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

readme #51

Closed
PhilippPro opened this issue Oct 19, 2016 · 6 comments
Closed

readme #51

PhilippPro opened this issue Oct 19, 2016 · 6 comments

Comments

@PhilippPro
Copy link

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
Copy link
Owner

zmjones commented Oct 19, 2016

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
#51, or mute the thread
https://github.com/notifications/unsubscribe-auth/ABEBhc49dWMz_O7SPxGPLEgj7fDxW21Nks5q1gQPgaJpZM4Ka4Fg
.

@zmjones
Copy link
Owner

zmjones commented Oct 19, 2016

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

@zmjones zmjones closed this as completed Oct 19, 2016
@PhilippPro
Copy link
Author

PhilippPro commented Oct 20, 2016

  • You still mention extract_proximity two times in the readme
  • You do not have references in some of the help files (e.g. partial_dependence); If this is intended let me know. ;)

@zmjones zmjones reopened this Oct 20, 2016
@zmjones
Copy link
Owner

zmjones commented Oct 20, 2016

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

@PhilippPro
Copy link
Author

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
Copy link
Owner

zmjones commented Oct 20, 2016

ok did those things. thanks

@zmjones zmjones closed this as completed Oct 21, 2016
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

No branches or pull requests

2 participants