S3FileProvider: Read only file providers

In terminological/uk-covid-datatools: Functions for sourcing, cleaning and calculating Rt for uk covid timeseries data

Description

Read only file providers

Read only file providers

Super classes

ukcovidtools::AbstractFileProvider -> ukcovidtools::ReadOnlyFileProvider -> S3FileProvider

Methods

Public methods

• S3FileProvider$new()

• S3FileProvider$finalize()

• S3FileProvider$listAllFiles()

• S3FileProvider$listFiles()

• S3FileProvider$getFile()

• S3FileProvider$print()

• S3FileProvider$clone()

Inherited methods

• ukcovidtools::AbstractFileProvider$relativePath()

• ukcovidtools::ReadOnlyFileProvider$processFiles()

---

Method new()

SFTP over SSH tunnel file provider

Usage

S3FileProvider$new(
  config,
  bucket = config$bucket,
  key = config$accesskey,
  secret = config$secretkey,
  region = config$region,
  ...
)

Arguments

config

- config object

bucket

- S3 bucket name

key

- S3 access key

secret

- S3 secret key

region

- S3 region

...

for compatibility

Returns

the provider

---

Method finalize()

Usage

S3FileProvider$finalize()

---

Method listAllFiles()

Usage

S3FileProvider$listAllFiles(directory = ".")

---

Method listFiles()

Usage

S3FileProvider$listFiles(directory = ".")

---

Method getFile()

Usage

S3FileProvider$getFile(filename)

---

Method print()

Usage

S3FileProvider$print()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

S3FileProvider$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

terminological/uk-covid-datatools documentation built on June 24, 2021, 8:16 p.m.