PersonProvider: PersonProvider

In charlatan: Make Fake Data

PersonProvider

Description

person names methods

Details

Note that with the male/female versions if the locale doesn't provide a male/female version then we fall back to the generic thing, e.g., if no female first name we give you first name

Super class

charlatan::BaseProvider -> PersonProvider

Public fields

locale

(character) the locale

formats

(character) person name formats

person

(character) person name data

messy

(logical) the messy setting, TRUE or FALSE

Methods

Public methods

• PersonProvider$allowed_locales()

• PersonProvider$new()

• PersonProvider$render()

• PersonProvider$first_name()

• PersonProvider$first_name_female()

• PersonProvider$first_name_male()

• PersonProvider$last_name()

• PersonProvider$last_name_female()

• PersonProvider$last_name_male()

• PersonProvider$prefix()

• PersonProvider$prefix_female()

• PersonProvider$prefix_male()

• PersonProvider$suffix()

• PersonProvider$suffix_female()

• PersonProvider$suffix_male()

• PersonProvider$clone()

Inherited methods

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

---

Method allowed_locales()

fetch the allowed locales for this provider

Usage

PersonProvider$allowed_locales()

---

Method new()

Create a new PersonProvider object

Usage

PersonProvider$new(locale = NULL, messy = FALSE)

Arguments

locale

(character) the locale to use. See ⁠$allowed_locales()⁠ for locales supported (default: en_US)

messy

(logical) make some messy data. Default: FALSE

Returns

A new PersonProvider object

---

Method render()

Make a person's name

Usage

PersonProvider$render(fmt = NULL)

Arguments

fmt

(character) a name format, default: NULL

---

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.

Examples

x <- PersonProvider$new()
x$locale
x$render()
x$first_name()
x$first_name_female()
x$first_name_male()
x$last_name()
x$last_name_female()
x$last_name_male()

x <- PersonProvider$new(locale = "en_GB")
x$locale
x$render()
x$first_name()
x$first_name_female()
x$first_name_male()
x$last_name()
x$last_name_female()
x$last_name_male()

z <- PersonProvider$new(locale = "fr_FR")
z$locale
z$render()
z$first_name()
z$first_name_female()
z$first_name_male()
z$last_name()
z$last_name_female()
z$last_name_male()
z$prefix()

z <- PersonProvider$new(locale = "de_AT")
z$locale
z$render()
z$first_name()
z$last_name()
z$prefix()

z <- PersonProvider$new(locale = "cs_CZ")
z$locale
z$render()
z$first_name()
z$first_name_female()
z$first_name_male()
z$last_name()
z$last_name_female()
z$last_name_male()
z$prefix()

z <- PersonProvider$new(locale = "es_MX")
z$locale
z$render()
z$first_name()
z$first_name_female()
z$first_name_male()
z$last_name()
z$prefix()

z <- PersonProvider$new(locale = "en_NZ")
z$locale
z$render()
z$first_name()
z$first_name_female()
z$first_name_male()
z$last_name()

PersonProvider$new(locale = "fr_CH")$render()
PersonProvider$new(locale = "fi_FI")$render()
PersonProvider$new(locale = "fa_IR")$render()
PersonProvider$new(locale = "es_ES")$render()
PersonProvider$new(locale = "de_DE")$render()
PersonProvider$new(locale = "de_AT")$render()
PersonProvider$new(locale = "cs_CZ")$render()
PersonProvider$new(locale = "bg_BG")$render()
PersonProvider$new(locale = "da_DK")$render()

charlatan documentation built on Sept. 13, 2023, 5:08 p.m.