File: hlabs.Rd

package info (click to toggle)
hmisc 5.2-4-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,044 kB
  • sloc: asm: 28,905; f90: 590; ansic: 415; xml: 160; fortran: 75; makefile: 2
file content (34 lines) | stat: -rw-r--r-- 1,042 bytes parent folder | download | duplicates (2)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/hlab.r
\name{hlabs}
\alias{hlabs}
\title{hlabs}
\usage{
hlabs(x, y, html = FALSE)
}
\arguments{
\item{x}{a single variable name, unquoted}

\item{y}{a single variable name, unquoted}

\item{html}{set to \code{TRUE} to render in html (for \code{plotly}), otherwise the result is \code{plotmath} expressions}
}
\value{
result of \code{\link[ggplot2:labs]{ggplot2::labs()}}
}
\description{
Front-end to ggplot2 labs Function
}
\details{
Runs \code{x}, \code{y}, or both through \code{\link[=hlab]{hlab()}} and passes the constructed labels to the \link[ggplot2:labs]{ggplot2::labs} function to specify x- and y-axis labels specially formatted for units of measurement
}
\examples{
# Name the current dataset d, or specify a name with
# options(curr_ds='...') or run `extractlabs`, then
# ggplot(d, aes(x,y)) + geom_point() + hlabs(x,y)
# to specify only the x-axis label use hlabs(x), or to
# specify only the y-axis label use hlabs(y=...)
}
\author{
Frank Harrell
}