Building the Package Documentation

Jump to bottom

Isaiah Norton edited this page Jul 8, 2021 · 1 revision

Inline documentation

Roxygen2 is used for doc generation. TileDB-R uses the Roxygen2's markdown support for writing inline documentation.

Website

TileDB-R uses pkgdown to build static documentation for the package. The docs are hosted using Github Pages enabled through the TileDB-R repo.

https://tiledb-inc.github.io/TileDB-R/

Installation

install.packages("pkgdown")

Package Doc Generation

pkgdown::build_site()

Customization of output is defined in the toplevel _pkgdown.yml file.

It may be useful to define a local helper script to update the docs:

#!/usr/bin/Rscript

library(pkgdown)
build_site()