LoremProvider {charlatan} | R Documentation |
lorem ipsum methods
charlatan::BaseProvider
-> LoremProvider
locale
(character) the locale
charlatan::BaseProvider$bothify()
charlatan::BaseProvider$check_locale()
charlatan::BaseProvider$lexify()
charlatan::BaseProvider$numerify()
charlatan::BaseProvider$random_digit()
charlatan::BaseProvider$random_digit_not_zero()
charlatan::BaseProvider$random_digit_not_zero_or_empty()
charlatan::BaseProvider$random_digit_or_empty()
charlatan::BaseProvider$random_element()
charlatan::BaseProvider$random_element_prob()
charlatan::BaseProvider$random_int()
charlatan::BaseProvider$random_letter()
charlatan::BaseProvider$randomize_nb_elements()
allowed_locales()
fetch the allowed locales for this provider
LoremProvider$allowed_locales()
new()
Create a new LoremProvider
object
LoremProvider$new( locale = NULL, sentence_punctuation = ".", word_connector = " " )
locale
(character) the locale to use. See
$allowed_locales()
for locales supported (default: en_US)
sentence_punctuation
(character) End of sentence punctuation
word_connector
(character) Default connector between words
A new LoremProvider
object
word()
Generate a random word
LoremProvider$word(ext_words = NULL)
ext_words
a character vector of words you would like to have instead of 'Lorem ipsum'
a single word
words()
Generate a character vector of random words
LoremProvider$words(nb = 3, ext_words = NULL)
nb
(integer) how many words to return
ext_words
a character vector of words you would like to have instead of 'Lorem ipsum'
many words
sentence()
Generate a random sentence
LoremProvider$sentence( nb_words = 6, variable_nb_words = TRUE, ext_words = NULL )
nb_words
(integer) around how many words the sentence should contain
variable_nb_words
set to FALSE
if you want exactly nb
words returned, otherwise the result may include a number of words
of nb
+/-40% (with a minimum of 1)
ext_words
a character vector of words you would like to have instead of 'Lorem ipsum'
a single sentence
sentences()
Generate a character vector of random sentences
LoremProvider$sentences(nb = 3, ext_words = NULL)
nb
(integer) how many sentences to return
ext_words
a character vector of words you would like to have instead of 'Lorem ipsum'
many sentences
paragraph()
Generate a single paragraph
LoremProvider$paragraph( nb_sentences = 3, variable_nb_sentences = TRUE, ext_words = NULL )
nb_sentences
(integer) around how many sentences the paragraph should contain
variable_nb_sentences
set to FALSE
if you want exactly nb
sentences returned, otherwise the result may include a number of
sentences of nb
+/-40% (with a minimum of 1)
ext_words
a character vector of words you would like to have instead of 'Lorem ipsum'
a single paragraph
paragraphs()
Generate many paragraphs
LoremProvider$paragraphs(nb = 3, ext_words = NULL)
nb
(integer) how many paragraphs to return
ext_words
a character vector of words you would like to have instead of 'Lorem ipsum'
many paragraphs
text()
Generate a random text string. Depending on the
max_nb_chars
, returns a string made of words, sentences, or
paragraphs.
LoremProvider$text(max_nb_chars = 200, ext_words = NULL)
max_nb_chars
Maximum number of characters the text should contain (minimum 5)
ext_words
a character vector of words you would like to have instead of 'Lorem ipsum'
character string of words
clone()
The objects of this class are cloneable with this method.
LoremProvider$clone(deep = FALSE)
deep
Whether to make a deep clone.
(x <- LoremProvider$new())
x$locale
x$word()
x$words(3)
x$words(6)
x$sentence()
x$sentences(3)
x$sentences(6)
x$paragraph()
x$paragraphs(3)
x$paragraphs(6)
cat(x$paragraphs(6), sep = "\n")
x$text(6)
x$text(10)
x$text(19)
x$text(25)
x$text(50)
x$text(300)
x$text(2000)
# set a different sentence_punctuation or word_connector
(x <- LoremProvider$new(sentence_punctuation = ";"))
x$paragraph(4)
(x <- LoremProvider$new(word_connector = " --- "))
x$paragraph(4)
# different locales
LoremProvider$new(locale = "ar_AA")$word()
LoremProvider$new(locale = "el_GR")$word()
LoremProvider$new(locale = "he_IL")$word()
LoremProvider$new(locale = "ja_JP")$word()
LoremProvider$new(locale = "zh_TW")$word()