1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/vignette.R
\name{latex_preamble}
\alias{latex_preamble}
\alias{latex_bibliography}
\title{LaTeX Utilities for Vignettes}
\usage{
latex_preamble(
PACKAGE,
R = TRUE,
CRAN = TRUE,
Bioconductor = TRUE,
GEO = TRUE,
ArrayExpress = TRUE,
biblatex = FALSE,
only = FALSE,
file = ""
)
latex_bibliography(PACKAGE, file = "")
}
\arguments{
\item{PACKAGE}{package name}
\item{R}{logical that indicate if general R commands should be added
(e.g. package names, inline R code format commands)}
\item{CRAN}{logical that indicate if general CRAN commands should be added
(e.g. CRAN package citations)}
\item{Bioconductor}{logical that indicate if general Bioconductor commands
should be added (e.g. Bioc package citations)}
\item{GEO}{logical that indicate if general GEOmnibus commands should be added
(e.g. urls to GEO datasets)}
\item{ArrayExpress}{logical that indicate if general ArrayExpress commands
should be added (e.g. urls to ArrayExpress datasets)}
\item{biblatex}{logical that indicates if a \code{\\bibliography} command
should be added to include references from the package's REFERENCES.bib file.}
\item{only}{a logical that indicates if the only the commands whose
dedicated argument is not missing should be considered.}
\item{file}{connection where to print. If \code{NULL} the result is returned
silently.}
}
\value{
A character string or nothing and output the command to stdout.
}
\description{
\code{latex_preamble} outputs/returns LaTeX command definitions to
be put in the preamble of vignettes.
}
\details{
Argument \code{PACKAGE} is not required for \code{latex_preamble}, but must
be correctly specified to ensure \code{biblatex=TRUE} generates the correct
bibliography command.
}
\section{Functions}{
\itemize{
\item \code{latex_bibliography()}: \code{latex_bibliography} prints or return a LaTeX command that includes a
package bibliography file if it exists.
}}
\examples{
latex_preamble()
latex_preamble(R=TRUE, only=TRUE)
latex_preamble(R=FALSE, CRAN=FALSE, GEO=FALSE)
latex_preamble(GEO=TRUE, only=TRUE)
}
|
