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/get_coord.R
\name{get_coord}
\alias{get_coord}
\title{Checks and Returns Data Coordinates from Multiple Input Options}
\usage{
get_coord(
group = 1L,
data.ranges = NULL,
coord = NULL,
npc = "left",
step = 0.1,
margin.npc = 0.05
)
}
\arguments{
\item{group}{integer ggplot's group id. Used to shift coordinates to avoid
overlaps.}
\item{data.ranges}{a numeric vector of length 2 containing the data ranges
(minimum and the maximum). Should be specified only when \code{coord =
NULL} and \code{npc} is specified. Used to convert \code{npc} to data
coordinates. Considered only when the argument \code{npc} is specified.}
\item{coord}{data coordinates (i.e., either x or y coordinates).}
\item{npc}{numeric (in [0-1]) or character vector of coordinates. If
character, should be one of c('right', 'left', 'bottom', 'top', 'center',
'centre', 'middle'). Note that, the \code{data.ranges}, \code{step} and
\code{margin.npc}, arguments are considered only when \code{npc} is
specified. The option \code{npc} is ignored when the argument \code{coord} is specified.}
\item{step}{numeric value in [0-1]. The step size for shifting coordinates
in npc units. Considered as horizontal step for x-axis and vertical step
for y-axis. For y-axis, the step value can be negative to reverse the order of groups.}
\item{margin.npc}{numeric [0-1] The margin added towards the nearest
plotting area edge when converting character coordinates into npc.}
}
\value{
a numeric vector representing data coordinates.
}
\description{
Checks and returns selected coordinates from multiple input
options, which can be either data (x-y) coordinates or npc (normalized
parent coordinates).
Helper function internally used in \code{ggpubr} function to guess the type
of coordinates specified by the user. For example, in the function
\code{stat_cor()}, users can specify either the option \code{label.x} (data
coordinates) or \code{label.x.npc} (npc coordinates); those coordinates are
passed to \code{get_coord()}, which will make some checking and then return
a unique coordinates for the label position.
}
\examples{
# If npc is specified, it is converted into data coordinates
get_coord(data.ranges = c(2, 20), npc = "left")
get_coord(data.ranges = c(2, 20), npc = 0.1)
# When coord is specified, no transformation is performed
# because this is assumed to be a data coordinate
get_coord(coord = 5)
# For grouped plots
res_top <- get_coord(
data.ranges = c(4.2, 36.4), group = c(1, 2, 3),
npc = "top", step = -0.1, margin.npc = 0
)
res_top
}
\seealso{
\code{\link{as_npc}}, \code{\link{npc_to_data_coord}}.
}
|
