andreas/FreesearchR
1
0
Fork 0
mirror of https://github.com/agdamsbo/FreesearchR.git synced 2025-09-12 18:09:39 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
FreesearchR/reference/import-file.html

114 lines
8.6 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ agdamsbo/FreesearchR@912fff747460485e47c04f51e33f864e7b1abbd4 🚀
2025-03-11 13:01:54 +00:00
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Import data from a file — import-file • freesearcheR</title><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/Montserrat-0.4.9/font.css" rel="stylesheet"><link href="../deps/Public_Sans-0.4.9/font.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><link href="../extra.css" rel="stylesheet"><meta property="og:title" content="Import data from a file — import-file"><meta name="description" content="Let user upload a file and import data"><meta property="og:description" content="Let user upload a file and import data"></head><body>
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
<nav class="navbar navbar-expand-lg fixed-top bg-primary" data-bs-theme="dark" aria-label="Site navigation"><div class="container">
<a class="navbar-brand me-2" href="../index.html">freesearcheR</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">25.3.2</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div id="navbar" class="collapse navbar-collapse ms-3">
<ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item"><a class="nav-link" href="../ROADMAP.html">Roadmap</a></li>
<li class="nav-item"><a class="nav-link" href="../QA.html">Q&amp;A</a></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
</ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
<input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/agdamsbo/freesearcheR/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
</ul></div>
</div>
</nav><div class="container template-reference-topic">
<div class="row">
<main id="main" class="col-md-9"><div class="page-header">
<h1>Import data from a file</h1>
<small class="dont-index">Source: <a href="https://github.com/agdamsbo/freesearcheR/blob/main/R/import-file-ext.R" class="external-link"><code>R/import-file-ext.R</code></a></small>
<div class="d-none name"><code>import-file.Rd</code></div>
</div>
<div class="ref-description section level2">
<p>Let user upload a file and import data</p>
</div>
<div class="section level2">
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">import_file_ui</span><span class="op">(</span></span>
<span> <span class="va">id</span>,</span>
Deploying to gh-pages from @ agdamsbo/FreesearchR@e3261ad3281f66dfbc60fa01abc58c1e4d4171b3 🚀
2025-03-13 12:03:04 +00:00
<span> title <span class="op">=</span> <span class="st">""</span>,</span>
Deploying to gh-pages from @ agdamsbo/FreesearchR@912fff747460485e47c04f51e33f864e7b1abbd4 🚀
2025-03-11 13:01:54 +00:00
<span> preview_data <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span> file_extensions <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">".csv"</span>, <span class="st">".txt"</span>, <span class="st">".xls"</span>, <span class="st">".xlsx"</span>, <span class="st">".rds"</span>, <span class="st">".fst"</span>, <span class="st">".sas7bdat"</span>,</span>
<span> <span class="st">".sav"</span><span class="op">)</span>,</span>
<span> layout_params <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"dropdown"</span>, <span class="st">"inline"</span><span class="op">)</span></span>
<span><span class="op">)</span></span>
<span></span>
<span><span class="fu">import_file_server</span><span class="op">(</span></span>
<span> <span class="va">id</span>,</span>
<span> btn_show_data <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span> show_data_in <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"popup"</span>, <span class="st">"modal"</span><span class="op">)</span>,</span>
<span> trigger_return <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"button"</span>, <span class="st">"change"</span><span class="op">)</span>,</span>
<span> return_class <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"data.frame"</span>, <span class="st">"data.table"</span>, <span class="st">"tbl_df"</span>, <span class="st">"raw"</span><span class="op">)</span>,</span>
<span> reset <span class="op">=</span> <span class="fu">reactive</span><span class="op">(</span><span class="cn">NULL</span><span class="op">)</span>,</span>
<span> read_fns <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="op">)</span></span>
<span><span class="op">)</span></span></code></pre></div>
</div>
<div class="section level2">
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
<dl><dt id="arg-preview-data">preview_data<a class="anchor" aria-label="anchor" href="#arg-preview-data"></a></dt>
<dd><p>Show or not a preview of the data under the file input.</p></dd>
<dt id="arg-file-extensions">file_extensions<a class="anchor" aria-label="anchor" href="#arg-file-extensions"></a></dt>
<dd><p>File extensions accepted by <code><a href="https://rdrr.io/pkg/shiny/man/fileInput.html" class="external-link">shiny::fileInput()</a></code>, can also be MIME type.</p></dd>
<dt id="arg-layout-params">layout_params<a class="anchor" aria-label="anchor" href="#arg-layout-params"></a></dt>
<dd><p>How to display import parameters : in a dropdown button or inline below file input.</p></dd>
<dt id="arg-read-fns">read_fns<a class="anchor" aria-label="anchor" href="#arg-read-fns"></a></dt>
<dd><p>Named list with custom function(s) to read data:</p><ul><li><p>the name must be the extension of the files to which the function will be applied</p></li>
<li><p>the value must be a function that can have 5 arguments (you can ignore some of them, but you have to use the same names),
passed by user through the interface:</p><ul><li><p><code>file</code>: path to the file</p></li>
<li><p><code>sheet</code>: for Excel files, sheet to read</p></li>
<li><p><code>skip</code>: number of row to skip</p></li>
<li><p><code>dec</code>: decimal separator</p></li>
<li><p><code>encoding</code>: file encoding</p></li>
<li><p><code>na.strings</code>: character(s) to interpret as missing values.</p></li>
</ul></li>
</ul></dd>
</dl></div>
</main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
</nav></aside></div>
<footer><div class="pkgdown-footer-left">
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.1.</p>
</div>
<div class="pkgdown-footer-right">
<p>Developed by Andreas Gammelgaard Damsbo. Provided without <strong>any warranty</strong>.</p>
</div>
</footer></div>
</body></html>
Reference in a new issue Copy permalink