TidyFileResourceClient

<p>Tidy file resource client</p>
<p>Tidy file resource client</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 

TidyFileResourceClient function

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

Format

<p><code>resourcer::ResourceClient</code> -&gt; <code>resourcer::FileResourceClient</code> -&gt; <code>TidyFileResourceClient</code></p>

Super classes


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/TidyFileResourceClient%24new()?package=resourcer&version=1.5.0" data-mini-rdoc="resourcer::TidyFileResourceClient$new()"><code>TidyFileResourceClient$new()</code></a></p></li>
<li><p><a href="/link/TidyFileResourceClient%24asDataFrame()?package=resourcer&version=1.5.0" data-mini-rdoc="resourcer::TidyFileResourceClient$asDataFrame()"><code>TidyFileResourceClient$asDataFrame()</code></a></p></li>
<li><p><a href="/link/TidyFileResourceClient%24clone()?package=resourcer&version=1.5.0" data-mini-rdoc="resourcer::TidyFileResourceClient$clone()"><code>TidyFileResourceClient$clone()</code></a></p></li>
</ul></p><p></p></div><p><details><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="resourcer" data-topic="ResourceClient" data-id="asTbl"><a href="/link/resourcer%3A%3AResourceClient%24asTbl()?package=resourcer&version=1.5.0" data-mini-rdoc="resourcer::resourcer::ResourceClient$asTbl()"><code>resourcer::ResourceClient$asTbl()</code></a></span></li>
<li><span class="pkg-link" data-pkg="resourcer" data-topic="ResourceClient" data-id="exec"><a href="/link/resourcer%3A%3AResourceClient%24exec()?package=resourcer&version=1.5.0" data-mini-rdoc="resourcer::resourcer::ResourceClient$exec()"><code>resourcer::ResourceClient$exec()</code></a></span></li>
<li><span class="pkg-link" data-pkg="resourcer" data-topic="ResourceClient" data-id="getConnection"><a href="/link/resourcer%3A%3AResourceClient%24getConnection()?package=resourcer&version=1.5.0" data-mini-rdoc="resourcer::resourcer::ResourceClient$getConnection()"><code>resourcer::ResourceClient$getConnection()</code></a></span></li>
<li><span class="pkg-link" data-pkg="resourcer" data-topic="ResourceClient" data-id="getResource"><a href="/link/resourcer%3A%3AResourceClient%24getResource()?package=resourcer&version=1.5.0" data-mini-rdoc="resourcer::resourcer::ResourceClient$getResource()"><code>resourcer::ResourceClient$getResource()</code></a></span></li>
<li><span class="pkg-link" data-pkg="resourcer" data-topic="FileResourceClient" data-id="close"><a href="/link/resourcer%3A%3AFileResourceClient%24close()?package=resourcer&version=1.5.0" data-mini-rdoc="resourcer::resourcer::FileResourceClient$close()"><code>resourcer::FileResourceClient$close()</code></a></span></li>
<li><span class="pkg-link" data-pkg="resourcer" data-topic="FileResourceClient" data-id="downloadFile"><a href="/link/resourcer%3A%3AFileResourceClient%24downloadFile()?package=resourcer&version=1.5.0" data-mini-rdoc="resourcer::resourcer::FileResourceClient$downloadFile()"><code>resourcer::FileResourceClient$downloadFile()</code></a></span></li>
</ul>
</details></p><p><hr>
<a id="method-TidyFileResourceClient-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Create a TidyFileResourceClient instance.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>TidyFileResourceClient$new(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>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>A TidyFileResourceClient object.</p>
</div><p></p><p></p><p><hr>
<a id="method-TidyFileResourceClient-asDataFrame"></a></p><div class="section" id="method-asdataframe-">
<h3>Method <code>asDataFrame()</code></h3>
<p>Coerce the resource value extracted from the file in tidy format to a data.frame.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>TidyFileResourceClient$asDataFrame(...)</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>...</code></dt>
<dd><p>Additional parameters to as.data.frame (not used yet).</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>A data.frame (more specifically a tibble).</p>
</div><p></p><p></p><p><hr>
<a id="method-TidyFileResourceClient-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>TidyFileResourceClient$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

Tidy file resource client — TidyFileResourceClient


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

<ul>
<li><p><a href='#method-TidyFileResourceClient-new'><code>TidyFileResourceClient$new()</code></a></p></li>
<li><p><a href='#method-TidyFileResourceClient-asDataFrame'><code>TidyFileResourceClient$asDataFrame()</code></a></p></li>
<li><p><a href='#method-TidyFileResourceClient-clone'><code>TidyFileResourceClient$clone()</code></a></p></li>
</ul>

</div><p><details><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="resourcer" data-topic="ResourceClient" data-id="asTbl"><a href='../../resourcer/html/ResourceClient.html#method-ResourceClient-asTbl'><code>resourcer::ResourceClient$asTbl()</code></a></span></li>
<li><span class="pkg-link" data-pkg="resourcer" data-topic="ResourceClient" data-id="exec"><a href='../../resourcer/html/ResourceClient.html#method-ResourceClient-exec'><code>resourcer::ResourceClient$exec()</code></a></span></li>
<li><span class="pkg-link" data-pkg="resourcer" data-topic="ResourceClient" data-id="getConnection"><a href='../../resourcer/html/ResourceClient.html#method-ResourceClient-getConnection'><code>resourcer::ResourceClient$getConnection()</code></a></span></li>
<li><span class="pkg-link" data-pkg="resourcer" data-topic="ResourceClient" data-id="getResource"><a href='../../resourcer/html/ResourceClient.html#method-ResourceClient-getResource'><code>resourcer::ResourceClient$getResource()</code></a></span></li>
<li><span class="pkg-link" data-pkg="resourcer" data-topic="FileResourceClient" data-id="close"><a href='../../resourcer/html/FileResourceClient.html#method-FileResourceClient-close'><code>resourcer::FileResourceClient$close()</code></a></span></li>
<li><span class="pkg-link" data-pkg="resourcer" data-topic="FileResourceClient" data-id="downloadFile"><a href='../../resourcer/html/FileResourceClient.html#method-FileResourceClient-downloadFile'><code>resourcer::FileResourceClient$downloadFile()</code></a></span></li>
</ul>
</details>

<hr>
<a id="method-TidyFileResourceClient-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Create a TidyFileResourceClient instance.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>TidyFileResourceClient$new(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>


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

</div><p><hr>
<a id="method-TidyFileResourceClient-asDataFrame"></a></p><div class='section' id='method-asdataframe-'>
<h3>Method <code>asDataFrame()</code></h3>
<p>Coerce the resource value extracted from the file in tidy format to a data.frame.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>TidyFileResourceClient$asDataFrame(...)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>...</code></dt>
<dd><p>Additional parameters to as.data.frame (not used yet).</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>A data.frame (more specifically a tibble).</p>
</div>

</div><p><hr>
<a id="method-TidyFileResourceClient-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>TidyFileResourceClient$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>


TidyFileResourceClient: Tidy file resource client

Description

Arguments

Format

Super classes

Methods

Public methods

Method `new()`

Usage

Arguments

Returns

Method `asDataFrame()`

Usage

Arguments

Returns

Method `clone()`

Usage

Arguments

Details

Description

Arguments

Format

Super classes

Methods

Public methods

Method new()

Usage

Arguments

Returns

Method asDataFrame()

Usage

Arguments

Returns

Method clone()

Usage

Arguments

Details

Method `new()`

Method `asDataFrame()`

Method `clone()`