configureBook {rebook}R Documentation

Helper configuration function for books

Description

Helper function to run at the top-level directory of Bioconductor book packages, to prepare for book compilation and to set up install-time resources for linking from other books.

Usage

configureBook(prefix = NULL, input = "index.Rmd", redirect = NULL)

Arguments

prefix

Optional string containing the prefix to be used when linking from other books.

input

Name of the index file for the book, see scrapeReferences.

redirect

Optional name of the file containing redirection information, to be passed to createRedirects.

Details

This function assumes that the bookdown-formatted book is located at inst/book inside the package. input is interpreted relative to this location, e.g., if input="index.Rmd", the file should be located at inst/book/index.Rmd.

Similarly, redirect is provided, the file should already be present in vignettes/. For example, if redirect="redirect.txt", the file should be located at vignettes/redirect.txt.

Value

A number of files are created in the package directory.

Author(s)

Aaron Lun

See Also

scrapeReferences, which is called by this function to create the reference table.

link, which is used by other books to link to the configured book.


[Package rebook version 1.3.1 Index]