Title: | Generate Lorem Ipsum Text |
---|---|
Description: | Quickly generate lorem ipsum placeholder text. Easy to integrate in 'R Markdown' documents and 'Shiny' apps. Includes an 'RStudio' addin to insert lorem ipsum into the current document. |
Authors: | Garrick Aden-Buie [aut, cre] |
Maintainer: | Garrick Aden-Buie <[email protected]> |
License: | MIT + file LICENSE |
Version: | 1.0.0.9000 |
Built: | 2024-08-31 02:39:05 UTC |
Source: | https://github.com/gadenbuie/lorem |
Renders ipsum()
placeholder text as HTML tags using
htmltools::as.tags()
. By default, paragraphs are rendering <p>
tags with
htmltools::p()
, but you may provide your own paragraph wrapper
function.
In general, you won't need to manually call this function, instead you can
just drop ipsum()
text into another htmltools::tag()
.
## S3 method for class 'lorem' as.tags(x, wrapper = NULL, ...)
## S3 method for class 'lorem' as.tags(x, wrapper = NULL, ...)
x |
Object to be converted. |
wrapper |
A function that takes a character string of a paragraph or
chunk of placeholder text and returns an |
... |
Any additional parameters. |
Returns an htmltools::tagList()
.
htmltools::div( lorem::ipsum(paragraphs = 3) ) htmltools::tags$ul( htmltools::as.tags( lorem::ipsum(paragraphs = 3, sentences = 1), wrapper = htmltools::tags$li ) )
htmltools::div( lorem::ipsum(paragraphs = 3) ) htmltools::tags$ul( htmltools::as.tags( lorem::ipsum(paragraphs = 3, sentences = 1), wrapper = htmltools::tags$li ) )
Generates lorem ipsum placeholder text for the requested number of sentences or paragraphs. You can control the number of sentences per paragraph and the average number of words per sentence, or simply enter the number of desired paragraphs for a completely random experience.
lorem::ipsum()
uses sampling and the random number generator and makes no
effort to shield the placeholder text generation from the main script, so
please only use this package for temporary placeholder text.
ipsum(paragraphs = 1, sentences = NULL, avg_words_per_sentence = 10) ipsum_words(n, collapse = TRUE) ipsum_starts(n)
ipsum(paragraphs = 1, sentences = NULL, avg_words_per_sentence = 10) ipsum_words(n, collapse = TRUE) ipsum_starts(n)
paragraphs |
Number of paragraphs of text to generate. |
sentences |
Number of sentences per paragraph. If |
avg_words_per_sentence |
Number of expected words per sentence. |
n |
Number of words to generate |
collapse |
Should the words be collapsed into a single string, separated
by spaces (default)? If |
A character vector of lorem ispum placeholder text, where each element in the vector is a paragraph of text.
ipsum()
: Generate paragraphs and sentences of lorem ipsum text.
ipsum_words()
: Generate lorem ipsum words, without punctuation.
ipsum_starts()
: Generate lorem ipsum starting words.
You can influence, to a degree, the amount of punctuation that is included
in the output using the lorem.punctuation_valence
option. This global
option should be a number between 0 and 1, or FALSE
to disable
punctuation altogether. When the value is closer to 1, more punctuation is
included in the sentences. When the value is closer to 0, less punctuation
will be inserted. The default value is 0.4.
# 1 paragraph of text lorem::ipsum(1) # 2 paragraphs with 2 and 3 sentences each lorem::ipsum(2, sentences = c(2, 3)) # 2 paragraphs with short sentences lorem::ipsum(2, avg_words_per_sentence = 4) # 2 paragraphs with long sentences lorem::ipsum(2, avg_words_per_sentence = 20)
# 1 paragraph of text lorem::ipsum(1) # 2 paragraphs with 2 and 3 sentences each lorem::ipsum(2, sentences = c(2, 3)) # 2 paragraphs with short sentences lorem::ipsum(2, avg_words_per_sentence = 4) # 2 paragraphs with long sentences lorem::ipsum(2, avg_words_per_sentence = 20)