Examples in the help files

zmjones / edarf

exploratory data analysis using random forests

MIT License

68 stars 11 forks source link

Examples in the help files #47

Closed PhilippPro closed 8 years ago

PhilippPro commented 8 years ago

Some things I noticed while looking at the help files:

extract_proximity has no example
extract_prox does not exist, but is in your readme file?
Why do you have ##not run in the plot_prox file?

PhilippPro commented 8 years ago

Moreover it maybe would be good to have links to other functions in the help file. ("See also" section).

Some functions like e.g. randomforest_dist are not easy to find, maybe they could be linked somewhere. (or maybe you do not want to show them as they are "unsupported"?)

zmjones commented 8 years ago

Ok thanks. Yes I want randomforest_dist to be omitted. I might remove it entirely. I made all of the other changes you suggested.

I also restructured the repo so that there is a package folder which I'll submit to cran. cran requires me to have the license formatted the way i did before.

PhilippPro commented 8 years ago

The bad thing is, that you now cannot install it anymore with devtools via

devtools::install_github("zmjones/edarf")

cause the package is in the folder.

zmjones commented 8 years ago

there is a subdir argument. i will say how to use this in the readme. devtools::install_github("zmjones/edarf", subdir = "pkg").

i don't think there is another way around that. cran requires i have the license setup differently.

PhilippPro commented 8 years ago

devtools::install_github("zmjones/edarf/pkg")

is also possible, this is not a big problem.