File: radialtext.Rd

package info (click to toggle)
r-cran-plotrix 3.8-4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,588 kB
  • sloc: makefile: 6
file content (73 lines) | stat: -rwxr-xr-x 3,174 bytes parent folder | download | duplicates (6)
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
\name{radialtext}
\alias{radialtext}
\title{Display text in a radial line}
\description{
 Displays a string in a radial line, rotating it to flow in the radial
 direction and optionally scaling each letter's size according to its
 distance from the center.
}
\usage{
 radialtext(x, center=c(0,0), start=NA, middle=1, end=NA, angle=0,
  deg=NA, expand=0, stretch=1, nice=TRUE, cex=NA, ...)
}
\arguments{
 \item{x}{A character string.}
 \item{center}{The center of the circular area in x/y user units.}
 \item{start}{The starting distance of the string from the center in
  x/y user units.}
 \item{middle}{The middle distance of the string from the center in
  x/y user units.}
 \item{end}{The ending distance of the string from the center in
  x/y user units.}
 \item{angle}{The angular position of the string in radians.}
 \item{deg}{The angular position of the string in degrees
  (takes precedence if not NA).}
 \item{expand}{Size expansion factor for characters, used only if
  \samp{start} specified.}
 \item{stretch}{How much to stretch the string for appearance, 1 for none.}
 \item{nice}{TRUE to auto-flip text to keep it upright, FALSE to let
  it be upside down.}
 \item{cex}{The overall character expansion factor, NA for par("cex").}
 \item{...}{Additional arguments passed to \samp{text}.}
}
\value{nil}
\details{
 This may not work on all devices, as not all graphic devices can rotate text to
 arbitrary angles. The output looks best on a Postscript or similar device that can
 rotate text without distortion. Rotated text often looks very ragged on small bitmaps.
 If the user passes a value for \samp{start}, this will override a value for
 \samp{middle} or \samp{end}. Likewise, a value for \samp{end} will override a
 value for \samp{middle}. Also, a value for \samp{deg} overrides any value passed
 to \samp{angle}. If \samp{expand} is 0, all characters will be the same size,
 while a value of 1 will scale characters so that one that is twice
 as far from the center will be twice as large. Negative values are permitted too,
 but \samp{expand} is only used if \samp{start} was specified.
}
\author{Ted Toal}
\seealso{\link{text}, \link{arctext}}
\examples{
 plot(0, xlim=c(1,5), ylim=c(1,5), main="Test of radialtext",
  xlab="", ylab="", type="n")
 points(3, 3, pch=20)
 radialtext("uncooked spaghetti", center=c(3,3),
  col="blue")
 radialtext("uncooked spaghetti", center=c(3,3),
  start=1.2, angle=pi/4, cex=0.8)
 radialtext("uncooked spaghetti", center=c(3,3),
  middle=1.2, angle=pi/4+0.1, cex=0.8)
 radialtext("uncooked spaghetti", center=c(3,3),
  end=1.2, angle=pi/4+0.2, cex=0.8)
 radialtext("uncooked spaghetti", center=c(3,3),
  start=0.5, deg=135, cex=0.8, col="green")
 radialtext("uncooked spaghetti", center=c(3,3),
  start=0.5, deg=145, cex=0.8, stretch=2)
 radialtext("uncooked spaghetti", center=c(3,3),
  start=0.5, deg=20, expand=0, col="red")
 radialtext("uncooked spaghetti", center=c(3,3),
  start=0.5, deg=250, expand=0.35)
 radialtext("uncooked spaghetti", center=c(3,3),
  start=0.75, deg=225, expand=1, col="gold")
 radialtext("uncooked spaghetti", center=c(3,3),
  start=0.5, deg=325, expand=-0.25, cex=2)
}
\keyword{misc}