LocalFileResourceGetter: Local file resource getter

In obiba/resourcer: Resource Resolver

Local file resource getter

Description

Local file resource getter

Local file resource getter

Format

A R6 object of class LocalFileResourceGetter

Details

Access a file that is stored in the local file system. No credentials apply.

Super class

resourcer::FileResourceGetter -> LocalFileResourceGetter

Methods

Public methods

• LocalFileResourceGetter$new()

• LocalFileResourceGetter$isFor()

• LocalFileResourceGetter$downloadFile()

• LocalFileResourceGetter$clone()

Inherited methods

• resourcer::FileResourceGetter$extractFileName()
• resourcer::FileResourceGetter$makeDownloadDir()

---

Method new()

Creates a new LocalFileResourceGetter instance.

Usage

LocalFileResourceGetter$new()

Returns

A LocalFileResourceGetter object.

---

Method isFor()

Check that the provided resource has a URL that locates a file stored in the local file system.

Usage

LocalFileResourceGetter$isFor(resource)

Arguments

resource

The resource object to validate.

Returns

A logical.

---

Method downloadFile()

Make a "resource.file" object from a local file resource.

Usage

LocalFileResourceGetter$downloadFile(resource, ...)

Arguments

resource

A valid resource object.

...

Unused additional parameters.

Returns

The "resource.file" object.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

LocalFileResourceGetter$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

obiba/resourcer documentation built on May 5, 2023, 10:08 a.m.