LoremProvider {charlatan} | R Documentation |
LoremProvider
Description
lorem ipsum methods for generating random words in a language. Lorem Ipsum is a placeholder text commonly used to demonstrate the visual form of a document or a typeface without relying on meaningful content.
Super classes
charlatan::BareProvider
-> charlatan::BaseProvider
-> LoremProvider
Methods
Public methods
Inherited methods
charlatan::BareProvider$bothify()
charlatan::BareProvider$lexify()
charlatan::BareProvider$numerify()
charlatan::BareProvider$random_digit()
charlatan::BareProvider$random_digit_not_zero()
charlatan::BareProvider$random_digit_not_zero_or_empty()
charlatan::BareProvider$random_digit_or_empty()
charlatan::BareProvider$random_element()
charlatan::BareProvider$random_element_prob()
charlatan::BareProvider$random_int()
charlatan::BareProvider$random_letter()
charlatan::BareProvider$randomize_nb_elements()
charlatan::BaseProvider$allowed_locales()
charlatan::BaseProvider$check_locale()
charlatan::BaseProvider$print()
Method new()
Create a new LoremProvider
object
Usage
LoremProvider$new(sentence_punctuation = ".", word_connector = " ")
Arguments
sentence_punctuation
(character) End of sentence punctuation
word_connector
(character) Default connector between words
Returns
A new LoremProvider
object
Method word()
Generate a random word
Usage
LoremProvider$word(ext_words = NULL)
Arguments
ext_words
a character vector of words you would like to have instead of "Lorem ipsum"
Returns
a single word
Method words()
Generate a character vector of random words
Usage
LoremProvider$words(nb = 3, ext_words = NULL)
Arguments
nb
(integer) how many words to return
ext_words
a character vector of words you would like to have instead of "Lorem ipsum"
Returns
many words
Method sentence()
Generate a random sentence
Usage
LoremProvider$sentence( nb_words = 6, variable_nb_words = TRUE, ext_words = NULL )
Arguments
nb_words
(integer) around how many words the sentence should contain
variable_nb_words
set to
FALSE
if you want exactlynb
words returned, otherwise the result may include a number of words ofnb
+/-40% (with a minimum of 1)ext_words
a character vector of words you would like to have instead of "Lorem ipsum"
Returns
a single sentence
Method sentences()
Generate a character vector of random sentences
Usage
LoremProvider$sentences(nb = 3, ext_words = NULL)
Arguments
nb
(integer) how many sentences to return
ext_words
a character vector of words you would like to have instead of "Lorem ipsum"
Returns
many sentences
Method paragraph()
Generate a single paragraph
Usage
LoremProvider$paragraph( nb_sentences = 3, variable_nb_sentences = TRUE, ext_words = NULL )
Arguments
nb_sentences
(integer) around how many sentences the paragraph should contain
variable_nb_sentences
set to
FALSE
if you want exactlynb
sentences returned, otherwise the result may include a number of sentences ofnb
+/-40% (with a minimum of 1)ext_words
a character vector of words you would like to have instead of "Lorem ipsum"
Returns
a single paragraph
Method paragraphs()
Generate many paragraphs
Usage
LoremProvider$paragraphs(nb = 3, ext_words = NULL)
Arguments
nb
(integer) how many paragraphs to return
ext_words
a character vector of words you would like to have instead of "Lorem ipsum"
Returns
many paragraphs
Method text()
Generate a random text string. Depending on the
max_nb_chars
, returns a string made of words, sentences, or
paragraphs.
Usage
LoremProvider$text(max_nb_chars = 200, ext_words = NULL)
Arguments
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"
Returns
character string of words
Method clone()
The objects of this class are cloneable with this method.
Usage
LoremProvider$clone(deep = FALSE)
Arguments
deep
Whether to make a deep clone.
Note
You cannot instantiate the Parent providers. You must use one of the localized one.
See Also
Other ParentProviders:
AddressProvider
,
ColorProvider
,
CompanyProvider
,
InternetProvider
,
JobProvider
,
PersonProvider
,
PhoneNumberProvider
,
TaxonomyProvider
,
UserAgentProvider