PersonProvider {charlatan} | R Documentation |
PersonProvider
Description
PersonProvider
PersonProvider
Details
Methods for Persons, methods for generating names.
Value
A PersonProvider object that can create names.
Super classes
charlatan::BareProvider
-> charlatan::BaseProvider
-> PersonProvider
Active bindings
messy
show current setting for messy. Either TRUE or FALSE depending on configuration and if this is even possible for the locale.
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 PersonProvider
object
Usage
PersonProvider$new(messy = FALSE)
Arguments
messy
make it messy
Method messy_is_possible()
internal function to figure out if messy is a valid option for this locale.
Usage
PersonProvider$messy_is_possible()
Method change_messy()
Change messy (if possible)
Usage
PersonProvider$change_messy(messy)
Arguments
messy
TRUE or FALSE
Method render()
Make a person's name
Usage
PersonProvider$render(fmt = NULL)
Arguments
fmt
(character) a name format, default:
NULL
Method messy_switch()
messy switch (internal). Always return a text, when messy is allowed return a messy version, but otherwise return a clean version.
Usage
PersonProvider$messy_switch(clean_choice, messy_choice)
Arguments
clean_choice
the clean version
messy_choice
the messy version
Method first_name()
make a first name
Usage
PersonProvider$first_name()
Method first_name_female()
make a female first name
Usage
PersonProvider$first_name_female()
Method first_name_male()
make a male first name
Usage
PersonProvider$first_name_male()
Method last_name()
make a last name
Usage
PersonProvider$last_name()
Method last_name_female()
make a female last name
Usage
PersonProvider$last_name_female()
Method last_name_male()
make a male last name
Usage
PersonProvider$last_name_male()
Method prefix()
make a name prefix
Usage
PersonProvider$prefix()
Method prefix_female()
make a female name prefix
Usage
PersonProvider$prefix_female()
Method prefix_male()
make a male name prefix
Usage
PersonProvider$prefix_male()
Method suffix()
make a name suffix
Usage
PersonProvider$suffix()
Method suffix_female()
make a female name suffix
Usage
PersonProvider$suffix_female()
Method suffix_male()
make a male name suffix
Usage
PersonProvider$suffix_male()
Method clone()
The objects of this class are cloneable with this method.
Usage
PersonProvider$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
,
LoremProvider
,
PhoneNumberProvider
,
TaxonomyProvider
,
UserAgentProvider