latex: Use Bioconductor style to format LaTeX vignettes

Description Usage Arguments Details Value Author(s) Examples

View source: R/latex.R

Description

This function inserts code into a document preamble to provide a consistent style to Bioconductor vignettes.

Usage

1
2
latex(..., width, titlecaps = TRUE, short.fignames = FALSE, fig.path,
  use.unsrturl = TRUE, relative.path = FALSE)

Arguments

...

Additional arguments, passed to options.

width

integer(1), maximum number of columns on a line used in printing. See options.

titlecaps

logical(1), emphasize the first sentence of float captions

short.fignames

logical(1), indicates whether \incfig figures should be inserted and referred to using short names equal to corresponding code chunk labels without any additional prefix.

fig.path

character(1), custom prefix to be used for figure file names when used with knitr; has no effect when compiled with Sweave. For details see opts_chunk.

use.unsrturl

logical(1), indicating that the ‘unsrturl’ style will be used (\bibliographystyle command not required).

relative.path

logical(1), copy supporting LaTeX files and use relative paths rather than absolute paths to system files.

Details

Use is described in the ‘Bioconductor LaTeX Style 2.0’ vignette.

By default the 'unsrturl' bibliography style is used, which automatically creates links to URL, DOIs, etc. Use a different bibliographystyle with use.unsrturl=FALSE and standard LaTeX commands for styling bibliographies.

Value

The return value is a character string directing LaTex to use the Bioconductor style file.

A side effect is setting any options specified as arguments.

Author(s)

Andrzej Oleś, Martin Morgan, Wolfgang Huber

Examples

1
2
## location of the .sty file
BiocStyle:::bioconductor.sty

Bioconductor/BiocStyle documentation built on Feb. 6, 2020, 11:22 p.m.