Commit 30db96bf authored by illo's avatar illo
Browse files

update docs

parent f62621b3
Pipeline #245168095 passed with stage
in 15 seconds
......@@ -75,20 +75,17 @@
<div id="installation" class="section level2">
<h2 class="hasAnchor">
<a href="#installation" class="anchor"></a>Installation</h2>
<!--
You can install the released version of mongopipe from [CRAN](https://CRAN.R-project.org) with:
``` r
# install.packages("mongopipe") # Not possible yet
```
-->
<p>You can install the development version of mongopipe on <a href="https://gitlab.com/rpkgs/mongopipe">gitlab</a> with:</p>
<p>You can install the released version of mongopipe from <a href="https://CRAN.R-project.org">CRAN</a> with:</p>
<div class="sourceCode" id="cb1"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span class="fu"><a href="https://rdrr.io/r/utils/install.packages.html">install.packages</a></span><span class="op">(</span><span class="st">"mongopipe"</span><span class="op">)</span></code></pre></div>
<p>or install the development version of mongopipe on <a href="https://gitlab.com/rpkgs/mongopipe">gitlab</a> with:</p>
<div class="sourceCode" id="cb2"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span class="fu">remotes</span><span class="fu">::</span><span class="fu"><a href="https://remotes.r-lib.org/reference/install_gitlab.html">install_gitlab</a></span><span class="op">(</span><span class="st">"illoRocks/mongopipe"</span><span class="op">)</span></code></pre></div>
</div>
<div id="example" class="section level2">
<h2 class="hasAnchor">
<a href="#example" class="anchor"></a>Example</h2>
<div class="sourceCode" id="cb2"><pre class="downlit sourceCode r">
<div class="sourceCode" id="cb3"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span class="kw"><a href="https://rdrr.io/r/base/library.html">library</a></span><span class="op">(</span><span class="va"><a href="https://rpkgs.gitlab.io/mongopipe">mongopipe</a></span><span class="op">)</span>
<span class="kw"><a href="https://rdrr.io/r/base/library.html">library</a></span><span class="op">(</span><span class="va"><a href="https://github.com/jeroen/mongolite/">mongolite</a></span><span class="op">)</span>
<span class="kw"><a href="https://rdrr.io/r/base/library.html">library</a></span><span class="op">(</span><span class="va"><a href="http://github.com/hadley/nycflights13">nycflights13</a></span><span class="op">)</span>
......@@ -117,7 +114,7 @@ You can install the released version of mongopipe from [CRAN](https://CRAN.R-pro
<span class="co">#&gt; 4 5fe23ddb5a72ab3dc0076731 257 16 JFK</span>
<span class="co">#&gt; 5 5fe23ddb5a72ab3dc0076731 242 0 JFK</span>
<span class="co">#&gt; 6 5fe23ddb5a72ab3dc0076731 240 -2 JFK</span></code></pre></div>
<div class="sourceCode" id="cb3"><pre class="downlit sourceCode r">
<div class="sourceCode" id="cb4"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span class="va">pipe</span> <span class="op">&lt;-</span> <span class="fu"><a href="reference/mongopipe.html">mongopipe</a></span><span class="op">(</span><span class="op">)</span> <span class="op">%&gt;%</span>
<span class="fu"><a href="reference/match.html">match</a></span><span class="op">(</span>faa<span class="op">=</span><span class="st">"ABQ"</span><span class="op">)</span> <span class="op">%&gt;%</span>
<span class="fu"><a href="reference/match.html">lookup</a></span><span class="op">(</span>from <span class="op">=</span> <span class="st">"test_flights"</span>, local_field <span class="op">=</span> <span class="st">"faa"</span>, foreign_field <span class="op">=</span> <span class="st">"dest"</span><span class="op">)</span> <span class="op">%&gt;%</span>
......@@ -158,6 +155,8 @@ You can install the released version of mongopipe from [CRAN](https://CRAN.R-pro
<div class="links">
<h2>Links</h2>
<ul class="list-unstyled">
<li>Download from CRAN at <br><a href="https://cloud.r-project.org/package=mongopipe">https://​cloud.r-project.org/​package=mongopipe</a>
</li>
<li>Browse source code at <br><a href="https://gitlab.com/rpkgs/mongopipe/">https://​gitlab.com/​rpkgs/​mongopipe/​</a>
</li>
<li>Report a bug at <br><a href="https://gitlab.com/rpkgs/mongopipe/-/issues">https://​gitlab.com/​rpkgs/​mongopipe/​-/​issues</a>
......
......@@ -2,5 +2,5 @@ pandoc: 2.7.3
pkgdown: 1.6.1
pkgdown_sha: ~
articles: {}
last_built: 2021-01-17T15:54Z
last_built: 2021-01-21T21:17Z
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment