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

function examples #7

Closed
goldingn opened this issue Aug 28, 2018 · 3 comments
Closed

function examples #7

goldingn opened this issue Aug 28, 2018 · 3 comments

Comments

@goldingn
Copy link

The following functions are mentioned in the package-level helpfile (note the links don't work), so will probably be used regularly, but they have only very minimal (or no) examples:
run_sdmbench()
get_benchmarking_data()
partition_data()
benchmark_sdm()
get_best_model_results()
plot_sdm_map()

It would be helpful to have more involved examples, with comments, showing the effects of the different arguments, and how you might use them in different situations. Scott's spocc package is again a good example of this, the major functions all have multiple examples.

Your examples seem to have very long lines too, so it's hard to read them. I'd recommend sticking to an 80-characters-per-line limit for these too.

@boyanangelov
Copy link
Owner

Working on this, will push the edits sometime next week.

@boyanangelov
Copy link
Owner

@goldingn I just pushed improved examples for the package functions. I think they cover the functionality well, but let me know what you think.

@goldingn
Copy link
Author

Yeah, these examples look great! Nice one!

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