File: ggparagraph.Rd

package info (click to toggle)
r-cran-ggpubr 0.6.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 3,240 kB
  • sloc: makefile: 2
file content (64 lines) | stat: -rw-r--r-- 1,713 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
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ggparagraph.R
\name{ggparagraph}
\alias{ggparagraph}
\alias{drawDetails.splitText}
\title{Draw a Paragraph of Text}
\usage{
ggparagraph(
  text,
  color = NULL,
  size = NULL,
  face = NULL,
  family = NULL,
  lineheight = NULL
)

\method{drawDetails}{splitText}(x, recording)
}
\arguments{
\item{text}{the text to plot.}

\item{color}{font color, example: color = "black"}

\item{size}{font size, example: size = 12}

\item{face}{font face. Allowed values are one of "plain", "italic", "bold",
"bold.italic".}

\item{family}{font family}

\item{lineheight}{Line height, example: lineheight = 2.}

\item{x}{a grid grob}

\item{recording}{a logical value indicating whether a grob is being added to
the display list or redrawn from the display list.}
}
\description{
Draw a paragraph o text. Splits a long text into multiple lines
 (by inserting line breaks) so that the output will fit within the current
 viewport.
}
\examples{
# Density plot
density.p <- ggdensity(iris, x = "Sepal.Length",
                      fill = "Species", palette = "jco")

# Text plot
text <- paste("iris data set gives the measurements in cm",
             "of the variables sepal length and width",
             "and petal length and width, respectively,",
             "for 50 flowers from each of 3 species of iris.",
             "The species are Iris setosa, versicolor, and virginica.", sep = " ")
text.p <- ggparagraph(text, face = "italic", size = 12)

# Arrange the plots on the same page
ggarrange(density.p, text.p,
         ncol = 1, nrow = 2,
         heights = c(1, 0.3))

}
\author{
Alboukadel Kassambara <alboukadel.kassambara@gmail.com>
}