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

set up vignettes / move wiki to vignettes #261

Open
maxheld83 opened this issue Sep 1, 2015 · 1 comment
Open

set up vignettes / move wiki to vignettes #261

maxheld83 opened this issue Sep 1, 2015 · 1 comment

Comments

@maxheld83
Copy link
Collaborator

It seems to me that vignettes may be a superior format / way of doing extended documentation of the kind we've currently been doing on the wiki.

For more information, see

Advantages would be:

  • Have this kind of extended documentation inside the repo, so it goes along with changes in the program
  • Available in various R clients, including RStudio, right in the terminal
  • Nice formatting options (via rmarkdown)
  • Literate programming approach to extended documentation (via rmarkdown and knitr)
  • Possibility to publish papers out of vignettes (to R Journal or Journal of Statistical Software or OS etc.)

Might be a gradual move, but I think for the future, this might be the way to go.

@maxheld83
Copy link
Collaborator Author

incidentally, we could keep the resulting rendered *.mds in the Wiki, too – but that would mean an extra step and things would be (confusingly) available in two separate places.

I'd suggest to use the wiki more for strictly "about"/"meta" kind of information, like how to install the program, etc.

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