openingDetails: Report opening details about the book

In LTLA/rebook: Re-using Content in Bioconductor Books

Report opening details about the book

Description

Report opening details about the book, to be executed as an R expression in the Date: field.

Usage

openingDetails(..., Copyright = NULL)

Arguments

...	Further named strings to be included in the opening details.
Copyright	String containing copyright information; defaults to "Bioconductor, <current year>".

Details

It is usually sufficient to set something like

date: "`r rebook::openingDetails()`"

in the YAML header of the book, thereby ensuring that the book details are printed after the title but before any contents. This assumes that none of the details have problematic characters, particularly double quotes.

Details are extracted from a DESCRIPTION file in the current or any parent directory. This assumes that authors are formatted as Authors@R and the License and Date fields are specified.

Value

A string containing the formatted details for inclusion into a YAML header.

Author(s)

Aaron Lun

Examples

wd <- getwd()
setwd(system.file(package="rebook"))
cat(openingDetails(), '\n')
setwd(wd)

LTLA/rebook documentation built on June 5, 2023, 6:24 p.m.