AddressProvider: AddressProvider

In ropensci/charlatan: Make Fake Data

AddressProvider

Description

Object to create addresses for a locale. Makes use of PersonProvider for creating street names.

Details

When there is no PersonProvider for this locale, we default back to en_US.

Value

Returns an AddressProvider object.

Super classes

charlatan::BareProvider -> charlatan::BaseProvider -> AddressProvider

Methods

Public methods

• AddressProvider$new()

• AddressProvider$address()

• AddressProvider$city()

• AddressProvider$street_name()

• AddressProvider$street_address()

• AddressProvider$postcode()

• AddressProvider$init_person_provider()

• AddressProvider$clone()

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 AddressProvider object

Usage

AddressProvider$new()

Returns

A new AddressProvider object

---

Method address()

Create an address, a combination of street, postal code and city.

Usage

AddressProvider$address()

---

Method city()

Create a city

Usage

AddressProvider$city()

---

Method street_name()

Create a street name.

Usage

AddressProvider$street_name()

---

Method street_address()

Create a street address, a combination of streetname and house indicator.

Usage

AddressProvider$street_address()

---

Method postcode()

Create a postal code

Usage

AddressProvider$postcode()

---

Method init_person_provider()

initialize the person provider (for use in addresses based on names)

Usage

AddressProvider$init_person_provider(locale)

Arguments

locale

locale

---

Method clone()

The objects of this class are cloneable with this method.

Usage

AddressProvider$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: ColorProvider, CompanyProvider, InternetProvider, JobProvider, LoremProvider, PersonProvider, PhoneNumberProvider, TaxonomyProvider, UserAgentProvider

ropensci/charlatan documentation built on Feb. 6, 2025, 1:07 p.m.