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

Revise vignettes based on Wickham book #26

Open
5 tasks
xiangzhu opened this issue Nov 11, 2018 · 0 comments
Open
5 tasks

Revise vignettes based on Wickham book #26

xiangzhu opened this issue Nov 11, 2018 · 0 comments
Assignees

Comments

@xiangzhu
Copy link
Collaborator

Below is a check list of guidelines on files in vignette / from Wickham's package book: http://r-pkgs.had.co.nz/vignettes.html.

This part seems straightforward since the main tools are rmarkdown and knitr, with which I have some experiences. However, preparing and organizing the contents of vignettes may be as hard as writing articles.

  • Start with devtools::use_vignette("my-vignette").
  • Can build all vignettes from the console with devtools::build_vignettes(), but this is rarely useful. Instead use devtools::build() to create a package bundle with the vignettes included.
  • Need to put yourself in the readers’ shoes, and adopt a “beginner’s mind”.
  • Any packages used by the vignette must be declared in the DESCRIPTION.
  • Need to watch the file size.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant