search

cjvanlissa / worcs

Rstudio project template and convenience functions for the Workflow for Open Reproducible Code in Science (WORCS)
https://cjvanlissa.github.io/worcs/
GNU General Public License v3.0
76 stars 11 forks source link

Update vignette index entries to match titles #114

Closed Bisaloo closed 3 years ago

Bisaloo commented 3 years ago

This will display nicer and more explicit titles in the listing from the CRAN landing page: https://cran.r-project.org/package=worcs

And according to Hadley Wickham, the vignette index entry should always match the title (source)

cjvanlissa commented 3 years ago

Thank you @Bisaloo , does this change the link to the vignettes on the pkgdown site? Because those vignettes are linked in the WORCS paper, and several other places. I don't know any way to set up a redirect on GitHub pages, so I would prefer not to make breaking changes here.

cjvanlissa commented 3 years ago

@Bisaloo also note the errors on Travis re: the naming of vignettes

Bisaloo commented 3 years ago

Thank you @Bisaloo , does this change the link to the vignettes on the pkgdown site? Because those vignettes are linked in the WORCS paper, and several other places. I don't know any way to set up a redirect on GitHub pages, so I would prefer not to make breaking changes here.

No, it will not change the link / cause breaking changes. The link to the vignettes on the pkgdown is derived from the file name, not from the vignette index entry.

For example, the citation.Rmd vignette is available at https://cjvanlissa.github.io/worcs/articles/citation.html even though the current index entry is citing.

cjvanlissa commented 3 years ago

In that case, thank you kindly!