Deploying to gh-pages from @ agdamsbo/FreesearchR@e144f9aeb9 🚀

This commit is contained in:
agdamsbo 2025-04-30 08:38:32 +00:00
commit b6618c504a
4 changed files with 12 additions and 6 deletions

View file

@ -89,9 +89,13 @@
</ol>
</div>
<div class="section level2">
<h2 id="install-locally">Install locally<a class="anchor" aria-label="anchor" href="#install-locally"></a>
<h2 id="run-locally-on-your-own-machine">Run locally on your own machine<a class="anchor" aria-label="anchor" href="#run-locally-on-your-own-machine"></a>
</h2>
<p>The <strong><em>FreesearchR</em></strong>-tool can also be launched locally. Any data.frame available in the global environment will be accessible from the interface.</p>
<p>The <strong><em>FreesearchR</em></strong> app can also run on your own machine with no data transmitted anywhere. Any data.frame available in the global environment will be accessible from the interface. Just follow the below steps:</p>
<ol style="list-style-type: decimal">
<li><p><strong>Requirement:</strong> You need to have <a href="https://www.r-project.org/" class="external-link"><em>R</em> installed</a> and possibly an editor like <a href="https://posit.co/download/rstudio-desktop/" class="external-link">RStudio</a>.</p></li>
<li>
<p>Then open the <em>R</em> console and copy/paste the following code, that will install the <a href="https://devtools.r-lib.org/" class="external-link">devtools</a> package and then the <a href="https://github.com/agdamsbo/FreesearchR" class="external-link">FreesearchR</a> <em>R</em>-package with its dependencies:</p>
<pre><code><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">require</a></span><span class="op">(</span><span class="st"><a href="https://devtools.r-lib.org/" class="external-link">"devtools"</a></span><span class="op">)</span></span>
<span><span class="fu">devtools</span><span class="fu">::</span><span class="fu"><a href="https://remotes.r-lib.org/reference/install_github.html" class="external-link">install_github</a></span><span class="op">(</span><span class="st">"agdamsbo/FreesearchR"</span><span class="op">)</span></span>
<span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://github.com/agdamsbo/FreesearchR" class="external-link">FreesearchR</a></span><span class="op">)</span></span>
@ -99,11 +103,13 @@
<span><span class="co"># in the interface like any other data.frame</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/utils/data.html" class="external-link">data</a></span><span class="op">(</span><span class="va">mtcars</span><span class="op">)</span></span>
<span><span class="fu"><a href="reference/launch_FreesearchR.html">launch_FreesearchR</a></span><span class="op">(</span><span class="op">)</span></span></code></pre>
</li>
</ol>
</div>
<div class="section level2">
<h2 id="code-of-conduct">Code of Conduct<a class="anchor" aria-label="anchor" href="#code-of-conduct"></a>
</h2>
<p>Please note that the <strong><em>FreesearchR</em></strong> project is released with a <a href="https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html" class="external-link">Contributor Code of Conduct</a>. By contributing to this project, you agree to abide by its terms.</p>
<p>Please note that the <strong><em>FreesearchR</em></strong> project is published with a <a href="https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html" class="external-link">Contributor Code of Conduct</a>. By contributing to this project, you agree to abide by its terms.</p>
</div>
<div class="section level2">
<h2 id="acknowledgements">Acknowledgements<a class="anchor" aria-label="anchor" href="#acknowledgements"></a>