ScpFileResourceGetter {resourcer}

SCP file resource getter

Description

SCP file resource getter

SCP file resource getter

Format

A R6 object of class ScpFileResourceGetter

Details

Access a file that is stored on a server accessible through SSH. Credentials apply.

Super class

resourcer::FileResourceGetter -> ScpFileResourceGetter

Methods

Public methods

• ScpFileResourceGetter$new()

• ScpFileResourceGetter$isFor()

• ScpFileResourceGetter$downloadFile()

• ScpFileResourceGetter$clone()

Inherited methods

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

Method new()

Creates a ScpFileResourceGetter instance.

Usage

ScpFileResourceGetter$new()

Returns

The ScpFileResourceGetter object.

Method isFor()

Check that the provided resource is a file accessible by SCP: the resource URL scheme must be "scp".

Usage

ScpFileResourceGetter$isFor(resource)

Arguments

resource

The resource object to evaluate.

Returns

A logical.

Method downloadFile()

Download the file described by the resource over an SSH connection.

Usage

ScpFileResourceGetter$downloadFile(resource, ...)

Arguments

resource

The resource that identifies the file.

...

Additional parameters (not used).

Returns

The "resource.file" object.

Method clone()

The objects of this class are cloneable with this method.

Usage

ScpFileResourceGetter$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.