helpers: Specify Rmarkdown document metadata

Description Usage Arguments Details Value Author(s) Examples

Description

Helper functions for including metadata in the document header.

Usage

1
2
3

Arguments

pkg

character(1), package name

Details

Use doc_date to include document compilation date in the document metadata field 'date', and pkg_ver for package version specification in the 'package' field.

Value

Markdown-formatted character string.

Author(s)

Andrzej Oleś <andrzej.oles@embl.de>, 2014-2015

Examples

1
2
3
4
5
## current date
doc_date()

## package name with version
pkg_ver("BiocStyle")

BiocStyle documentation built on Nov. 26, 2020, 2:01 a.m.