Skip to content

Add @examples throughout package (maybe query-less versions of vignette code) #69

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

Closed
brookslogan opened this issue Apr 13, 2022 · 2 comments · Fixed by #77
Closed

Add @examples throughout package (maybe query-less versions of vignette code) #69

brookslogan opened this issue Apr 13, 2022 · 2 comments · Fixed by #77
Assignees
Labels
good first issue Good for newcomers

Comments

@brookslogan
Copy link
Contributor

The package currently has a lot of useful vignettes explaining its functionality. However, at least for Emacs ESS users, @examples are a bit more accessible: they pop up within the editor, don't require finding and running a vignette command and finding the output in a browser, allow running within the help window frame, and allow copy-paste with editor navigation shortcuts. It would be nice to have some of the examples from the vignettes, perhaps with artificial data in place of API downloads, in the roxygen @examples. In some cases, this would also be a step toward #42.

@ChloeYou
Copy link
Contributor

ChloeYou commented May 5, 2022

@kenmawer @ChloeYou assigned to task

@kenmawer
Copy link
Contributor

kenmawer commented May 6, 2022

I'm suggesting that we also have some sort of built-in dataset that can be used for the examples, just like how R has the iris and mtcars datasets that are used for the examples.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants