FileProvider: FileProvider

In ropensci/charlatan: Make Fake Data

FileProvider

Description

file methods

Super classes

charlatan::BareProvider -> charlatan::BaseProvider -> FileProvider

Methods

Public methods

• FileProvider$new()

• FileProvider$mime_type()

• FileProvider$file_name()

• FileProvider$file_extension()

• FileProvider$file_path()

• FileProvider$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 FileProvider object

Usage

FileProvider$new()

Returns

A new FileProvider object

---

Method mime_type()

a random mime type

Usage

FileProvider$mime_type(category = NULL)

Arguments

category

(character) a mime type category of mime types, one of application, audio, image, message, model, multipart, text or video. default: NULL

---

Method file_name()

a random file name

Usage

FileProvider$file_name(category = NULL, extension = NULL)

Arguments

category

(character) a category of file extension type, one of audio, image, office, text or video. default: NULL. If this is given, extension is ignored

extension

(character) a file extension. if this is given, category is ignored.

---

Method file_extension()

a random file extension

Usage

FileProvider$file_extension(category = NULL)

Arguments

category

(character) a category of file extension type, one of audio, image, office, text or video. default: NULL

---

Method file_path()

a random file path

Usage

FileProvider$file_path(depth = 1, category = NULL, extension = NULL)

Arguments

depth

(character) depth of the file (depth >= 0). default: 1

category

(character) a category of file extension type, one of audio, image, office, text or video. default: NULL. If this is given, extension is ignored

extension

(character) a file extension. if this is given, category is ignored.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

FileProvider$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

ropensci/charlatan documentation built on Oct. 24, 2023, 9:15 a.m.