Title: Generate Lorem Ipsum Text
Version: 1.0.0
Description: Quickly generate lorem ipsum placeholder text. Easy to integrate in RMarkdown documents. Includes an RStudio addin to insert lorem ipsum into the current document.
License: MIT + file LICENSE
URL: https://github.com/gadenbuie/lorem, http://pkg.garrickadenbuie.com/lorem/
BugReports: https://github.com/gadenbuie/lorem/issues
Depends: R (≥ 2.10)
Imports: htmltools, knitr, stats
Suggests: rstudioapi, testthat (≥ 3.0.0), withr
Config/Needs/website: gadenbuie/grkgdown
Config/testthat/edition: 3
Encoding: UTF-8
RoxygenNote: 7.2.3
NeedsCompilation: no
Packaged: 2023-03-09 04:09:28 UTC; garrick
Author: Garrick Aden-Buie ORCID iD [aut, cre]
Maintainer: Garrick Aden-Buie <garrick@adenbuie.com>
Repository: CRAN
Date/Publication: 2023-03-09 09:40:06 UTC

lorem: Generate Lorem Ipsum Text

Description

Quickly generate lorem ipsum placeholder text. Easy to integrate in RMarkdown documents. Includes an RStudio addin to insert lorem ipsum into the current document.

Author(s)

Maintainer: Garrick Aden-Buie garrick@adenbuie.com (ORCID)

See Also

Useful links:

Render placeholder text as HTML tags

Description

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().

Usage

## S3 method for class 'lorem'
as.tags(x, wrapper = NULL, ...)

Arguments

x

Object to be converted.

wrapper

A function that takes a character string of a paragraph or chunk of placeholder text and returns an htmltools::tag(). By default, lorem ipsum text is wrapped in htmltools::p().

...

Any additional parameters.

Value

Returns an htmltools::tagList().

Examples

htmltools::div(
  lorem::ipsum(paragraphs = 3)
)

htmltools::tags$ul(
  htmltools::as.tags(
    lorem::ipsum(paragraphs = 3, sentences = 1),
    wrapper = htmltools::tags$li
  )
)

Generate Lorem Ipsum Text

Description

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.

Usage

ipsum(paragraphs = 1, sentences = NULL, avg_words_per_sentence = 10)

ipsum_words(n, collapse = TRUE)

ipsum_starts(n)

Arguments

paragraphs

Number of paragraphs of text to generate.

sentences

Number of sentences per paragraph. If NULL, then a random number of sentences per paragraph (approximately 3-8) will be chosen. Alternatively, sentences can be a vector of integers representing the number of sentences per paragraph.

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 FALSE, the chosen words are returned as a character vector.

Value

A character vector of lorem ispum placeholder text, where each element in the vector is a paragraph of text.

Functions

Options

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.

Examples

# 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)