BiocStyle (version 2.0.2)

latex: Use Bioconductor styles to format LaTeX vignettes

Description

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

Usage

latex(..., width=90, short.fignames=FALSE, fig.path, error=FALSE, use.unsrturl=TRUE)

Arguments

...

Additional arguments, passed to options.

width

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

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.

error

logical(1), behavior of knitr when errors occur in vignette code chunks, has no effect when compiled with Sweave. The default (FALSE) means that errors stop vignette processing, which is appropriate when packages are being built and checked. For details see opts_chunk.

use.unsrturl

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

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.

Details

Use is described in the ‘Bioconductor LaTeX Style’ 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.

Examples

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