The R Project SVN R

Rev

Rev 68948 | Rev 80079 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 68948 Rev 76185
Line 1... Line 1...
1 
% File src/library/grDevices/man/axisTicks.Rd
 1 
% File src/library/grDevices/man/axisTicks.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 2011-2013 R Core Team
 3 
% Copyright 2011-2019 R Core Team
4 
% Distributed under GPL 2 or later
 4 
% Distributed under GPL 2 or later
5 
 
 5 
 
6 
\name{axisTicks}
 6 
\name{axisTicks}
7 
\alias{axisTicks}
 7 
\alias{axisTicks}
8 
\alias{.axisPars}
 8 
\alias{.axisPars}
Line 12... Line 12...
12 
  traditional \R graphics do it.  This is interesting particularly for
 12 
  traditional \R graphics do it.  This is interesting particularly for
13 
  log scale axes.
 13 
  log scale axes.
14 
}
 14 
}
15 
\usage{
 15 
\usage{
16 
axisTicks(usr, log, axp = NULL, nint = 5)
 16 
axisTicks(usr, log, axp = NULL, nint = 5)
17 
 .axisPars(usr, log = FALSE, nintLog = 5)
 17 
.axisPars(usr, log = FALSE,  nintLog = 5)
18 
}
 18 
}
19 
\arguments{
 19 
\arguments{
20 
  \item{usr}{numeric vector of length 2, with \code{c(min, max)} axis
 20 
  \item{usr}{numeric vector of length 2, with \code{c(min, max)} axis
21 
    extents.}
 21 
    extents.}
22 
  \item{log}{logical indicating if a log scale is (thought to be) in
 22 
  \item{log}{logical indicating if a log scale is (thought to be) in
Line 30... Line 30...
30 
  \item{nint, nintLog}{positive integer value indicating
 30 
  \item{nint, nintLog}{positive integer value indicating
31 
    (\emph{approximately}) the desired number of intervals.
 31 
    (\emph{approximately}) the desired number of intervals.
32 
    \code{nintLog} is used \bold{only} for the case \code{log = TRUE}.}
 32 
    \code{nintLog} is used \bold{only} for the case \code{log = TRUE}.}
33 
}
 33 
}
34 
\details{
 34 
\details{
35 
  \code{axisTicks(usr, *)} calls \code{.axisPars(usr, ..)} when
 35 
  \code{axisTicks(usr, *)} calls \code{.axisPars(usr, ..)} to set
36 
  \code{axp} is missing (or \code{NULL}).
 36 
  \code{axp} when that is missing or \code{NULL}.
- 
 
 37 
 
- 
 
 38 
  Apart from that, \code{\link{axisTicks}()} just calls the C function
- 
 
 39 
  \code{CreateAtVector()} in \file{<Rsrc>/src/main/plot.c} which is also
- 
 
 40 
  called by the base \pkg{graphics} package function
- 
 
 41 
  \code{\link[graphics]{axis}(side, *)} when its argument \code{at} is not
37 
% FIXME: say more
 42 
  specified.
38 
}
 43 
}
39 
\value{
 44 
\value{
40 
  \code{axisTicks()} returns a numeric vector of potential axis tick
 45 
  \code{axisTicks()} returns a numeric vector of potential axis tick
41 
  locations, of length approximately \code{nint+1}.
 46 
  locations, of length approximately \code{nint+1}.
42 
 
 47 
 
Line 45... Line 50...
45 
    axis extents.}
 50 
    axis extents.}
46 
  \item{n}{integer (code), with the same meaning as
 51 
  \item{n}{integer (code), with the same meaning as
47 
    \code{\link{par}("?axp")[3]}.}
 52 
    \code{\link{par}("?axp")[3]}.}
48 
}
 53 
}
49 
\seealso{
 54 
\seealso{
50 
  \code{\link{axTicks}};
 55 
  \code{\link[graphics]{axTicks}},
51 
  \code{\link[graphics]{axis}}, and \code{\link[graphics]{par}} (from
 56 
  \code{\link[graphics]{axis}}, and \code{\link[graphics]{par}} all from
52 
  the \pkg{graphics} package).
 57 
  the \pkg{graphics} package.
53 
}
 58 
}
54 
\examples{
 59 
\examples{
55 
##--- Demonstrating correspondence between graphics'
 60 
##--- Demonstrating correspondence between graphics'
56 
##--- axis() and the graphics-engine agnostic  axisTicks() :
 61 
##--- axis() and the graphics-engine agnostic  axisTicks() :
57 
 
 62