mirror of
https://github.com/agdamsbo/FreesearchR.git
synced 2025-12-16 09:32:10 +01:00
134 lines
9.9 KiB
HTML
134 lines
9.9 KiB
HTML
<!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 an Environment — import-globalenv • FreesearchR</title><!-- favicons --><link rel="icon" type="image/png" sizes="96x96" href="../favicon-96x96.png"><link rel="icon" type="”image/svg+xml”" href="../favicon.svg"><link rel="apple-touch-icon" sizes="180x180" href="../apple-touch-icon.png"><link rel="icon" sizes="any" href="../favicon.ico"><link rel="manifest" href="../site.webmanifest"><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.10/font.css" rel="stylesheet"><link href="../deps/Public_Sans-0.4.10/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 an Environment — import-globalenv"><meta name="description" content="Let the user select a dataset from its own environment or from a package's environment.
|
|
Modified from datamods"><meta property="og:description" content="Let the user select a dataset from its own environment or from a package's environment.
|
|
Modified from datamods"><meta property="og:image" content="https://agdamsbo.github.io/FreesearchR/logo.png"><script defer src="https://stats.freesearchr.org/script.js" data-website-id="85bfd1e8-2cbe-4a4a-aa34-1dfb2960905b"></script></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">FreesearchR</a>
|
|
|
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">25.12.5</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="nav-item"><a class="nav-link" href="../articles/FreesearchR.html">Get started</a></li>
|
|
<li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
|
|
<li class="nav-item dropdown">
|
|
<button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
|
|
<ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><a class="dropdown-item" href="../articles/data-types.html">Data types</a></li>
|
|
<li><a class="dropdown-item" href="../articles/missingness.html">Missingness in data</a></li>
|
|
<li><a class="dropdown-item" href="../articles/session.html">Session info</a></li>
|
|
<li><a class="dropdown-item" href="../articles/visuals.html">On visuals</a></li>
|
|
</ul></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&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/FreesearchR/" 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">
|
|
<img src="../logo.png" class="logo" alt=""><h1>Import data from an Environment</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/agdamsbo/FreesearchR/blob/main/R/import_globalenv-ext.R" class="external-link"><code>R/import_globalenv-ext.R</code></a></small>
|
|
<div class="d-none name"><code>import-globalenv.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description section level2">
|
|
<p>Let the user select a dataset from its own environment or from a package's environment.
|
|
Modified from datamods</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_globalenv_ui</span><span class="op">(</span></span>
|
|
<span> <span class="va">id</span>,</span>
|
|
<span> globalenv <span class="op">=</span> <span class="cn">TRUE</span>,</span>
|
|
<span> packages <span class="op">=</span> <span class="fu">datamods</span><span class="fu">::</span><span class="fu"><a href="https://dreamrs.github.io/datamods/reference/get_data_packages.html" class="external-link">get_data_packages</a></span><span class="op">(</span><span class="op">)</span>,</span>
|
|
<span> title <span class="op">=</span> <span class="cn">TRUE</span></span>
|
|
<span><span class="op">)</span></span>
|
|
<span></span>
|
|
<span><span class="fu">import_globalenv_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"><a href="https://rdrr.io/pkg/shiny/man/reactive.html" class="external-link">reactive</a></span><span class="op">(</span><span class="cn">NULL</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-id">id<a class="anchor" aria-label="anchor" href="#arg-id"></a></dt>
|
|
<dd><p>Module's ID.</p></dd>
|
|
|
|
|
|
<dt id="arg-globalenv">globalenv<a class="anchor" aria-label="anchor" href="#arg-globalenv"></a></dt>
|
|
<dd><p>Search for data in Global environment.</p></dd>
|
|
|
|
|
|
<dt id="arg-packages">packages<a class="anchor" aria-label="anchor" href="#arg-packages"></a></dt>
|
|
<dd><p>Name of packages in which to search data.</p></dd>
|
|
|
|
|
|
<dt id="arg-title">title<a class="anchor" aria-label="anchor" href="#arg-title"></a></dt>
|
|
<dd><p>Module's title, if <code>TRUE</code> use the default title,
|
|
use <code>NULL</code> for no title or a <code>shiny.tag</code> for a custom one.</p></dd>
|
|
|
|
|
|
<dt id="arg-btn-show-data">btn_show_data<a class="anchor" aria-label="anchor" href="#arg-btn-show-data"></a></dt>
|
|
<dd><p>Display or not a button to display data in a modal window if import is successful.</p></dd>
|
|
|
|
|
|
<dt id="arg-show-data-in">show_data_in<a class="anchor" aria-label="anchor" href="#arg-show-data-in"></a></dt>
|
|
<dd><p>Where to display data: in a <code>"popup"</code> or in a <code>"modal"</code> window.</p></dd>
|
|
|
|
|
|
<dt id="arg-trigger-return">trigger_return<a class="anchor" aria-label="anchor" href="#arg-trigger-return"></a></dt>
|
|
<dd><p>When to update selected data:
|
|
<code>"button"</code> (when user click on button) or
|
|
<code>"change"</code> (each time user select a dataset in the list).</p></dd>
|
|
|
|
|
|
<dt id="arg-return-class">return_class<a class="anchor" aria-label="anchor" href="#arg-return-class"></a></dt>
|
|
<dd><p>Class of returned data: <code>data.frame</code>, <code>data.table</code>, <code>tbl_df</code> (tibble) or <code>raw</code>.</p></dd>
|
|
|
|
|
|
<dt id="arg-reset">reset<a class="anchor" aria-label="anchor" href="#arg-reset"></a></dt>
|
|
<dd><p>A <code>reactive</code> function that when triggered resets the data.</p></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.2.0.</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>
|
|
|