R Graphical Manual

Browse All

Last data update: 2014.03.03

R: Use Bioconductor styles to format LaTeX vignettes

latex2

R Documentation

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

latex2(..., width, titlecaps = TRUE, short.fignames=FALSE, fig.path,
       use.unsrturl=TRUE)

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 (`ibliographystyle` command not required).

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<c3><85><c2><9b>, Martin Morgan, Wolfgang Huber

Examples

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

Results


R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(BiocStyle)
> png(filename="/home/ddbj/snapshot/RGM3/R_BC/result/BiocStyle/latex2.Rd_%03d_medium.png", width=480, height=480)
> ### Name: latex2
> ### Title: Use Bioconductor styles to format LaTeX vignettes
> ### Aliases: latex2
> ### Keywords: manip
> 
> ### ** Examples
> 
> ## location of the .sty file
> BiocStyle:::bioconductor2.sty
[1] "/home/ddbj/local/lib64/R/library/BiocStyle/resources/tex/Bioconductor2.sty"
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>