AddressProvider: AddressProvider

In charlatan: Make Fake Data

AddressProvider

Description

address methods

Super class

charlatan::BaseProvider -> AddressProvider

Public fields

locale

(character) xxx

city_prefixes

(character) xxx

city_suffixes

(character) xxx

street_suffixes

(character) xxx

building_number_formats

(character) xxx

postcode_formats

(character) xxx

states

(character) xxx

states_abbr

(character) xxx

military_state_abbr

(character) xxx

military_ship_prefix

(character) xxx

military_apo_format

(character) xxx

military_dpo_format

(character) xxx

city_formats

(character) xxx

street_name_formats

(character) xxx

street_address_formats

(character) xxx

address_formats

(character) xxx

secondary_address_formats

(character) xxx

countries

(character) xxx

country_codes

(character) xxx

locale_data

(character) xxx

Methods

Public methods

• AddressProvider$allowed_locales()

• AddressProvider$new()

• AddressProvider$city_suffix()

• AddressProvider$street_suffix()

• AddressProvider$building_number()

• AddressProvider$city()

• AddressProvider$street_name()

• AddressProvider$street_address()

• AddressProvider$postcode()

• AddressProvider$address()

• AddressProvider$country()

• AddressProvider$country_code()

• AddressProvider$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

AddressProvider$allowed_locales()

---

Method new()

Create a new AddressProvider object

Usage

AddressProvider$new(locale = NULL)

Arguments

locale

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

Returns

A new AddressProvider object

---

Method city_suffix()

city suffix

Usage

AddressProvider$city_suffix()

---

Method street_suffix()

street suffix

Usage

AddressProvider$street_suffix()

---

Method building_number()

building numeber

Usage

AddressProvider$building_number()

---

Method city()

city

Usage

AddressProvider$city()

---

Method street_name()

street name

Usage

AddressProvider$street_name()

---

Method street_address()

street address

Usage

AddressProvider$street_address()

---

Method postcode()

postal code

Usage

AddressProvider$postcode()

---

Method address()

address

Usage

AddressProvider$address()

---

Method country()

country name

Usage

AddressProvider$country()

---

Method country_code()

country code

Usage

AddressProvider$country_code()

---

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.

Examples

(z <- AddressProvider$new())
z$locale
z$allowed_locales()
z$city_suffix()
z$street_suffix()
z$building_number()
z$city()
z$country()
z$street_name()
z$street_address()
z$address()
z$country()
z$country_code()
z$postcode()

# en_GB
(z <- AddressProvider$new("en_GB"))
z$locale
z$locale_data
z$locale_data$postcode_sets
z$postcode
z$postcode()
z$street_name()

# en_NZ
(z <- AddressProvider$new("en_NZ"))
z$locale
z$street_name()

# es_ES
(z <- AddressProvider$new("es_ES"))
z$locale
z$street_name()

# nl_NL
(z <- AddressProvider$new("nl_NL"))
z$locale
z$street_name()
z$postcode()
z$city()

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