Are vignettes necessary? Or is it fine just to have the same info on the github README?

Package development
1

Hi

I wondering if it is worthwhile me converting my github README information on my package to a vignette? Or whether people people prefer to access this information directly from github?

Thanks
David

2

You might find the discussion at Vignette standards · Issue #55 · ropensci/software-review-meta · GitHub relevant.

Note that when converting README info for a vignette you can re-use Rmd fragments.

Personally, for both vignette or README, I prefer to access information on pkgdown websites. :smile_cat:

1 Like
3

Without any hard data on this we can only speculate. Personally I feel that few people look at vignettes included in the package, and more people use READMEs and pkgdown sites.

An alternative to the vignette is to include the README in the package's manual page, which is also relatively straightforward with roxygen2: callr/callr-package.R at 7896f1742e64a76eac7a7c9f4c9afa3c12f2d4cc · r-lib/callr · GitHub

3 Likes
4

This topic was automatically closed 7 days after the last reply. New replies are no longer allowed.

If you have a query related to it or one of the replies, start a new topic and refer back with a link.