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.

Sign up for GitHub

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

Jump to bottom

Getting started vignette #41

Closed
seabbs opened this issue Jul 24, 2020 · 1 comment
Closed

Getting started vignette #41

seabbs opened this issue Jul 24, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@seabbs
Copy link
Contributor

seabbs commented Jul 24, 2020

The basic functionality of the package is fairly obvious but some features (like the optional support for memoise) could really do with being briefly explained. Some examples of combining the data set in a simple analysis would also be really nice.

This would be ideally suited to a simple getting started vignette that could then be linked to from the README, the package website, and the package description.
@seabbs seabbs added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Jul 24, 2020
@seabbs seabbs mentioned this issue Jul 24, 2020
Closed
@seabbs
Copy link
Contributor Author

seabbs commented Aug 18, 2020

Related to this the current README is overly intimidating and doesn't give a nice quick guide to using the package. Moving some of the information in the vignette elsewhere and replacing it with a small example would be a good start.

@kathsherratt kathsherratt mentioned this issue Nov 1, 2020
Merged
@seabbs seabbs closed this as completed Jan 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@seabbs