| Line 1... |
Line 1... |
| 1 |
% File src/library/graphics/man/mtext.Rd
|
1 |
% File src/library/graphics/man/mtext.Rd
|
| 2 |
% Part of the R package, https://www.R-project.org
|
2 |
% Part of the R package, https://www.R-project.org
|
| 3 |
% Copyright 1995-2024 R Core Team
|
3 |
% Copyright 1995-2025 R Core Team
|
| 4 |
% Distributed under GPL 2 or later
|
4 |
% Distributed under GPL 2 or later
|
| 5 |
|
5 |
|
| 6 |
\name{mtext}
|
6 |
\name{mtext}
|
| 7 |
\title{Write Text into the Margins of a Plot}
|
7 |
\title{Write Text into the Margins of a Plot}
|
| 8 |
% mtext is defined via do_mtext(.) in src/main/plot.c ---
|
8 |
% mtext is defined via do_mtext(.) in src/main/plot.c ---
|
| Line 17... |
Line 17... |
| 17 |
\alias{mtext}
|
17 |
\alias{mtext}
|
| 18 |
\arguments{
|
18 |
\arguments{
|
| 19 |
\item{text}{a character or \link{expression} vector specifying
|
19 |
\item{text}{a character or \link{expression} vector specifying
|
| 20 |
the \emph{text} to be written. Other objects are coerced by
|
20 |
the \emph{text} to be written. Other objects are coerced by
|
| 21 |
\code{\link{as.graphicsAnnot}}.}
|
21 |
\code{\link{as.graphicsAnnot}}.}
|
| 22 |
\item{side}{on which side of the plot (1=bottom, 2=left, 3=top, 4=right).}
|
22 |
\item{side}{on which side of the plot (1=below, 2=left, 3=above, 4=right).}
|
| 23 |
\item{line}{on which \I{MARgin} line, starting at 0 counting outwards.}
|
23 |
\item{line}{on which \I{MARgin} line, starting at 0 counting outwards.}
|
| 24 |
\item{outer}{use outer margins if available.}
|
24 |
\item{outer}{use outer margins if available.}
|
| 25 |
\item{at}{give location of each string in user coordinates. If the
|
25 |
\item{at}{give location of each string in user coordinates. If the
|
| 26 |
component of \code{at} corresponding to a particular text item is
|
26 |
component of \code{at} corresponding to a particular text item is
|
| 27 |
not a finite value (the default), the location will be determined
|
27 |
not a finite value (the default), the location will be determined
|
| Line 35... |
Line 35... |
| 35 |
parallel to the axis the default is to centre the string.}
|
35 |
parallel to the axis the default is to centre the string.}
|
| 36 |
\item{padj}{adjustment for each string perpendicular to the reading
|
36 |
\item{padj}{adjustment for each string perpendicular to the reading
|
| 37 |
direction (which is controlled by \code{adj}). For strings parallel
|
37 |
direction (which is controlled by \code{adj}). For strings parallel
|
| 38 |
to the axes, \code{padj = 0} means bottom alignment,
|
38 |
to the axes, \code{padj = 0} means bottom alignment,
|
| 39 |
and \code{padj = 1} means top alignment (relative to the axis line).
|
39 |
and \code{padj = 1} means top alignment (relative to the axis line).
|
| 40 |
|
40 |
|
| 41 |
If \code{padj} is not a finite value (the default), the value of
|
41 |
If \code{padj} is not a finite value (the default), the value of
|
| 42 |
\code{par("las")} determines the adjustment. For strings plotted
|
42 |
\code{par("las")} determines the adjustment. For strings plotted
|
| 43 |
perpendicular to the axis the default is to centre the string.}
|
43 |
perpendicular to the axis the default is to centre the string.}
|
| 44 |
\item{cex}{character expansion factor. \code{NULL} and \code{NA}
|
44 |
\item{cex}{character expansion factor. \code{NULL} and \code{NA}
|
| 45 |
are equivalent to \code{1.0}. This is an absolute measure, not
|
45 |
are equivalent to \code{1.0}. This is an absolute measure, not
|
The R Project SVN
R