plot_text | R Documentation |
plot_text
parses text
(from a file or from user input)
and plots its individual characters
as a tile plot (using ggplot2).
plot_text(
x = NA,
file = "",
char_bg = " ",
lbl_tiles = TRUE,
lbl_rotate = FALSE,
cex = 3,
fontface = 1,
family = "sans",
col_lbl = "black",
col_bg = "white",
pal = pal_ds4psy[1:5],
pal_extend = TRUE,
case_sense = FALSE,
borders = TRUE,
border_col = "white",
border_size = 0.5
)
x |
The text to plot (as a character vector).
Different elements denote different lines of text.
If |
file |
A text file to read (or its path).
If |
char_bg |
Character used as background.
Default: |
lbl_tiles |
Add character labels to tiles?
Default: |
lbl_rotate |
Rotate character labels?
Default: |
cex |
Character size (numeric).
Default: |
fontface |
Font face of text labels (numeric).
Default: |
family |
Font family of text labels (name).
Default: |
col_lbl |
Color of text labels.
Default: |
col_bg |
Color of |
pal |
Color palette for filling tiles
of text (used in order of character frequency).
Default: |
pal_extend |
Boolean: Should |
case_sense |
Boolean: Distinguish
lower- vs. uppercase characters?
Default: |
borders |
Boolean: Add borders to tiles?
Default: |
border_col |
Color of borders (if |
border_size |
Size of borders (if |
plot_text
blurs the boundary between a text
and its graphical representation by adding visual options
for coloring characters based on their frequency counts.
(Note that plot_chars
provides additional
support for matching regular expressions.)
plot_text
is character-based:
Individual characters are plotted at equidistant x-y-positions
with color settings for text labels and tile fill colors.
By default, the color palette pal
(used for tile fill colors) is scaled
to indicate character frequency.
plot_text
invisibly returns a
description of the plot (as a data frame).
An invisible data frame describing the plot.
plot_charmap
for plotting character maps;
plot_chars
for creating and plotting character maps;
map_text_coord
for mapping text to a table of character coordinates;
map_text_regex
for mapping text to a character table and matching patterns;
read_ascii
for parsing text from file or user input;
pal_ds4psy
for default color palette.
Other plot functions:
plot_charmap()
,
plot_chars()
,
plot_fn()
,
plot_fun()
,
plot_n()
,
plot_tiles()
,
theme_clean()
,
theme_ds4psy()
,
theme_empty()
# (A) From text string(s):
plot_text(x = c("Hello", "world!"))
plot_text(x = c("Hello world!", "How are you today?"))
# (B) From user input:
# plot_text() # (enter text in Console)
# (C) From text file:
## Create a temporary file "test.txt":
# cat("Hello world!", "This is a test file.",
# "Can you see this text?",
# "Good! Please carry on...",
# file = "test.txt", sep = "\n")
# plot_text(file = "test.txt")
## Set colors, pal_extend, and case_sense:
# cols <- c("steelblue", "skyblue", "lightgrey")
# cols <- c("firebrick", "olivedrab", "steelblue", "orange", "gold")
# plot_text(file = "test.txt", pal = cols, pal_extend = TRUE)
# plot_text(file = "test.txt", pal = cols, pal_extend = FALSE)
# plot_text(file = "test.txt", pal = cols, pal_extend = FALSE, case_sense = TRUE)
## Customize text and grid options:
# plot_text(file = "test.txt", col_lbl = "darkblue", cex = 4, family = "sans", fontface = 3,
# pal = "gold1", pal_extend = TRUE, border_col = NA)
# plot_text(file = "test.txt", family = "serif", cex = 6, lbl_rotate = TRUE,
# pal = NA, borders = FALSE)
# plot_text(file = "test.txt", col_lbl = "white", pal = c("green3", "black"),
# border_col = "black", border_size = .2)
## Color ranges:
# plot_text(file = "test.txt", pal = c("red2", "orange", "gold"))
# plot_text(file = "test.txt", pal = c("olivedrab4", "gold"))
# unlink("test.txt") # clean up.
## (B) From text file (in subdir):
# plot_text(file = "data-raw/txt/hello.txt") # requires txt file
# plot_text(file = "data-raw/txt/ascii.txt", cex = 5,
# col_bg = "grey", char_bg = "-")
## (C) From user input:
# plot_text() # (enter text in Console)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.