LocalFileResourceGetter

<p>Local file resource getter</p>
<p>Local file resource getter</p>

A resource represents some data or a computation unit. It is
described by a URL and credentials. This package proposes a Resource model
with "resolver" and "client" classes to facilitate the access and the usage of the
resources.

Yannick Marcon

resourcer

Resource Resolver

OBiBa group 

LocalFileResourceGetter function

<p>A R6 object of class LocalFileResourceGetter</p>

Format

<p><code>resourcer::FileResourceGetter</code> -&gt; <code>LocalFileResourceGetter</code></p>

Super class


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/LocalFileResourceGetter%24new()?package=resourcer&version=1.3.0" data-mini-rdoc="resourcer::LocalFileResourceGetter$new()"><code>LocalFileResourceGetter$new()</code></a></p></li>
<li><p><a href="/link/LocalFileResourceGetter%24isFor()?package=resourcer&version=1.3.0" data-mini-rdoc="resourcer::LocalFileResourceGetter$isFor()"><code>LocalFileResourceGetter$isFor()</code></a></p></li>
<li><p><a href="/link/LocalFileResourceGetter%24downloadFile()?package=resourcer&version=1.3.0" data-mini-rdoc="resourcer::LocalFileResourceGetter$downloadFile()"><code>LocalFileResourceGetter$downloadFile()</code></a></p></li>
<li><p><a href="/link/LocalFileResourceGetter%24clone()?package=resourcer&version=1.3.0" data-mini-rdoc="resourcer::LocalFileResourceGetter$clone()"><code>LocalFileResourceGetter$clone()</code></a></p></li>
</ul></p><p></p></div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="resourcer" data-topic="FileResourceGetter" data-id="extractFileName"><a href="/link/resourcer%3A%3AFileResourceGetter%24extractFileName()?package=resourcer&version=1.3.0" data-mini-rdoc="resourcer::resourcer::FileResourceGetter$extractFileName()"><code>resourcer::FileResourceGetter$extractFileName()</code></a></span></li>
<li><span class="pkg-link" data-pkg="resourcer" data-topic="FileResourceGetter" data-id="makeDownloadDir"><a href="/link/resourcer%3A%3AFileResourceGetter%24makeDownloadDir()?package=resourcer&version=1.3.0" data-mini-rdoc="resourcer::resourcer::FileResourceGetter$makeDownloadDir()"><code>resourcer::FileResourceGetter$makeDownloadDir()</code></a></span></li>
</ul>
</details></p><p><hr>
<a id="method-LocalFileResourceGetter-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Creates a new LocalFileResourceGetter instance.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>LocalFileResourceGetter$new()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>A LocalFileResourceGetter object.</p>
</div></p><p></p><p><hr>
<a id="method-LocalFileResourceGetter-isFor"></a></p><div class="section" id="method-isfor-">
<h3>Method <code>isFor()</code></h3>
<p>Check that the provided resource has a URL that locates a file stored in the local file system.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>LocalFileResourceGetter$isFor(resource)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>resource</code></dt>
<dd><p>The resource object to validate.</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>A logical.</p>
</div><p></p><p></p><p><hr>
<a id="method-LocalFileResourceGetter-downloadFile"></a></p><div class="section" id="method-downloadfile-">
<h3>Method <code>downloadFile()</code></h3>
<p>Make a "resource.file" object from a local file resource.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>LocalFileResourceGetter$downloadFile(resource, ...)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>resource</code></dt>
<dd><p>A valid resource object.</p></dd></dl></div></p><p>
<dt><code>...</code></dt>
<dd><p>Unused additional parameters.</p></dd></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>The "resource.file" object.</p>
</div><p></p><p></p><p><hr>
<a id="method-LocalFileResourceGetter-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>LocalFileResourceGetter$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

Local file resource getter — LocalFileResourceGetter


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-LocalFileResourceGetter-new'><code>LocalFileResourceGetter$new()</code></a></p></li>
<li><p><a href='#method-LocalFileResourceGetter-isFor'><code>LocalFileResourceGetter$isFor()</code></a></p></li>
<li><p><a href='#method-LocalFileResourceGetter-downloadFile'><code>LocalFileResourceGetter$downloadFile()</code></a></p></li>
<li><p><a href='#method-LocalFileResourceGetter-clone'><code>LocalFileResourceGetter$clone()</code></a></p></li>
</ul>

</div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="resourcer" data-topic="FileResourceGetter" data-id="extractFileName"><a href='../../resourcer/html/FileResourceGetter.html#method-FileResourceGetter-extractFileName'><code>resourcer::FileResourceGetter$extractFileName()</code></a></span></li>
<li><span class="pkg-link" data-pkg="resourcer" data-topic="FileResourceGetter" data-id="makeDownloadDir"><a href='../../resourcer/html/FileResourceGetter.html#method-FileResourceGetter-makeDownloadDir'><code>resourcer::FileResourceGetter$makeDownloadDir()</code></a></span></li>
</ul>
</details>

<hr>
<a id="method-LocalFileResourceGetter-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Creates a new LocalFileResourceGetter instance.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>LocalFileResourceGetter$new()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>A LocalFileResourceGetter object.</p>
</div>

</div><p><hr>
<a id="method-LocalFileResourceGetter-isFor"></a></p><div class='section' id='method-isfor-'>
<h3>Method <code>isFor()</code></h3>
<p>Check that the provided resource has a URL that locates a file stored in the local file system.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>LocalFileResourceGetter$isFor(resource)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>resource</code></dt>
<dd><p>The resource object to validate.</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>A logical.</p>
</div>

</div><p><hr>
<a id="method-LocalFileResourceGetter-downloadFile"></a></p><div class='section' id='method-downloadfile-'>
<h3>Method <code>downloadFile()</code></h3>
<p>Make a "resource.file" object from a local file resource.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>LocalFileResourceGetter$downloadFile(resource, ...)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>resource</code></dt>
<dd><p>A valid resource object.</p></dd>


<dt><code>...</code></dt>
<dd><p>Unused additional parameters.</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>The "resource.file" object.</p>
</div>

</div><p><hr>
<a id="method-LocalFileResourceGetter-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>LocalFileResourceGetter$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


LocalFileResourceGetter: Local file resource getter

Description

Arguments

Format

Super class

Methods

Public methods

Method `new()`

Usage

Returns

Method `isFor()`

Usage

Arguments

Returns

Method `downloadFile()`

Usage

Arguments

Returns

Method `clone()`

Usage

Arguments

Details

Description

Arguments

Format

Super class

Methods

Public methods

Method new()

Usage

Returns

Method isFor()

Usage

Arguments

Returns

Method downloadFile()

Usage

Arguments

Returns

Method clone()

Usage

Arguments

Details

Method `new()`

Method `isFor()`

Method `downloadFile()`

Method `clone()`