Showing posts with label website. Show all posts
Showing posts with label website. Show all posts

Tuesday, 1 August 2017

Building a website with pkgdown: a short guide

As promised in my last post, here is a short guide with some tips and tricks for building a documentation website for an R package using pkgdown.

In the end, this guide ended up way longer than I was expecting, but I hope you'll find it useful, although it often replicates information already available in pkgdown documentation !

Prerequisites


To build a website using pkgdown, all you need to have is an R package hosted on Git Hub, with a file structure "tweaked" with some functionality provided by devtools

Assuming you are using RStudio, and that you didn't already do this, open the project corresponding to your package and (as a minimum) run:

require(devtools)
use_readme_rmd()
use_news_md()
use_vignette("test")  #substitute with the name of your package


Tuesday, 25 July 2017

The new MODIStsp website (based on pkgdown) is online !

The MODIStsp website, which lay abandoned since several months on github pages, recently underwent a major overhaul thanks to pkgdown. The new site is now available at http://lbusett.github.io/MODIStsp/