Skip to content

Commit

Permalink
Built site for gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
mjfrigaard committed Oct 28, 2023
1 parent 892b95d commit 46448e0
Show file tree
Hide file tree
Showing 20 changed files with 187 additions and 199 deletions.
2 changes: 1 addition & 1 deletion .nojekyll
Original file line number Diff line number Diff line change
@@ -1 +1 @@
8eebf45a
b19f3a89
26 changes: 7 additions & 19 deletions app_packages.html
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,6 @@ <h2 id="toc-title">Contents</h2>
<li><a href="#data-chapter-7" id="toc-data-chapter-7" class="nav-link" data-scroll-target="#data-chapter-7">Data (Chapter 7)</a></li>
<li><a href="#launch-chapter-8" id="toc-launch-chapter-8" class="nav-link" data-scroll-target="#launch-chapter-8">Launch (Chapter 8)</a></li>
<li><a href="#external-files-chapter-9" id="toc-external-files-chapter-9" class="nav-link" data-scroll-target="#external-files-chapter-9">External files (Chapter 9)</a></li>
<li><a href="#tests-chapter-10" id="toc-tests-chapter-10" class="nav-link" data-scroll-target="#tests-chapter-10">Tests (Chapter 10)</a></li>
</ul></li>
</ul>
<div class="toc-actions"><div><i class="bi bi-github"></i></div><div class="action-links"><p><a href="https://github.com/mjfrigaard/shinyap/edit/main/app_packages.qmd" class="toc-action">Edit this page</a></p><p><a href="https://github.com/mjfrigaard/shinyap/issues/new" class="toc-action">Report an issue</a></p></div></div></nav>
Expand Down Expand Up @@ -514,7 +513,7 @@ <h3 class="anchored" data-anchor-id="packages-chapter-3">Packages (Chapter 3)</h
<li><p><a href="https://github.com/mjfrigaard/moviesApp/tree/03_proj-app"><code>03_proj-app</code></a> is an ‘advanced’ package from the previous chapter</p></li>
<li><p><a href="https://github.com/mjfrigaard/moviesApp/tree/04_description"><code>04_description</code></a> is a branch from <code>03_proj-app</code> and adds the seven mandatory <code>DESCRIPTION</code> fields.</p></li>
<li><p><a href="https://github.com/mjfrigaard/moviesApp/tree/05_rproj"><code>05_rproj</code></a> is a branch from <code>04_description</code> and manually converts the shiny app project to a shiny app-package using the <code>.Rproj</code> file.</p></li>
<li><p><a href="https://github.com/mjfrigaard/moviesApp/tree/06_create-package"><code>06_create-package</code></a> is a branch from <code>03_proj-app</code> and creates a package using <code>usethis::create_package()</code></p></li>
<li><p><a href="https://github.com/mjfrigaard/moviesApp/tree/06a_create-package"><code>06a_create-package</code></a> is a branch from <code>05_rproj</code> and creates a package using <code>usethis::create_package()</code></p></li>
</ol>
</div>
</div>
Expand All @@ -539,7 +538,7 @@ <h3 class="anchored" data-anchor-id="development-chapter-4">Development (Chapter
<div style="font-size: 1.05em; color: #282b2d;">
<p>The code for Chapter 4 (Development) is stored in the following branch:</p>
<ol type="1">
<li><a href="https://github.com/mjfrigaard/moviesApp/tree/06_devtools"><code>06_devtools</code></a> is a branch from the manually converted app-package in <a href="https://github.com/mjfrigaard/moviesApp/tree/05_rproj"><code>05_rproj</code></a></li>
<li><a href="https://github.com/mjfrigaard/moviesApp/tree/06b_devtools"><code>06b_devtools</code></a> is a branch from the manually converted app-package in <a href="https://github.com/mjfrigaard/moviesApp/tree/05_rproj"><code>05_rproj</code></a></li>
</ol>
</div>
</div>
Expand All @@ -563,7 +562,7 @@ <h3 class="anchored" data-anchor-id="development-chapter-4">Development (Chapter
<dl class="code-annotation-container-hidden code-annotation-container-grid">
<dt data-target-cell="annotated-cell-1" data-target-annotation="1">1</dt>
<dd>
<span data-code-lines="10" data-code-annotation="1" data-code-cell="annotated-cell-1">Always leave an empty line in the <code>DESCRIPTION</code></span>
<span data-code-annotation="1" data-code-lines="10" data-code-cell="annotated-cell-1">Always leave an empty line in the <code>DESCRIPTION</code></span>
</dd>
</dl>
</div>
Expand All @@ -590,20 +589,19 @@ <h2 class="anchored" data-anchor-id="app-packages">App-packages</h2>
<p>The following six chapter will continue with app-package development, emphasizing developing a shiny application within a package structure.</p>
<p>In the following chapters, we’ll be using code from the <code>moviesApp</code> repository:</p>
<div class="callout callout-style-simple callout-note no-icon callout-titled">
<div class="callout-header d-flex align-content-center" data-bs-toggle="collapse" data-bs-target=".callout-6-contents" aria-controls="callout-6" aria-expanded="true" aria-label="Toggle callout">
<div class="callout-header d-flex align-content-center" data-bs-toggle="collapse" data-bs-target=".callout-6-contents" aria-controls="callout-6" aria-expanded="false" aria-label="Toggle callout">
<div class="callout-icon-container">
<i class="callout-icon no-icon"></i>
</div>
<div class="callout-title-container flex-fill">
<span style="font-weight: bold; font-size: 1.15em;"><code>moviesApp/tree/main</code></span>
<span style="font-weight: bold; font-size: 1.15em;"><code>moviesApp/tree/</code></span>
</div>
<div class="callout-btn-toggle d-inline-block border-0 py-1 ps-1 pe-0 float-end"><i class="callout-toggle"></i></div>
</div>
<div id="callout-6" class="callout-6-contents callout-collapse collapse show">
<div id="callout-6" class="callout-6-contents callout-collapse collapse">
<div class="callout-body-container callout-body">
<div style="font-size: 1.05em; color: #282b2d;">
<p>The code for the next section can be found in the <a href="https://github.com/mjfrigaard/moviesApp/tree/main"><code>moviesApp</code></a> repository.</p>
<p>The <a href="https://github.com/mjfrigaard/moviesApp/tree/main"><code>main</code></a> branch of <code>moviesApp</code> is identical to the <a href="https://github.com/mjfrigaard/moviesApp/tree/06_create-package"><code>06_create-package</code></a> branch from the <code>moviesApp</code> repository from the previous section:</p>
<p>The code for the next section can be found in the <a href="https://github.com/mjfrigaard/moviesApp/tree/06b_devtools"><code>06b_devtools</code></a> branch of <a href="https://github.com/mjfrigaard/moviesApp/"><code>moviesApp</code></a> repository.</p>
<div class="sourceCode" id="cb2"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="ex">moviesApp/</span> </span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a> <span class="ex">├──</span> DESCRIPTION</span>
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a> <span class="ex">├──</span> NAMESPACE</span>
Expand Down Expand Up @@ -696,16 +694,6 @@ <h3 class="anchored" data-anchor-id="external-files-chapter-9">External files (C
<li><p><code>system.file()</code></p></li>
<li><p><code>addResourcePath()</code></p></li>
</ul>
</section>
<section id="tests-chapter-10" class="level3">
<h3 class="anchored" data-anchor-id="tests-chapter-10">Tests (Chapter 10)</h3>
<p><a href="./tests.html">Tests</a> introduces the <a href="https://testthat.r-lib.org/reference/describe.html">BDD</a> functions and how to ‘scope’ the tests in your app-package before writing any code.</p>
<ul>
<li><p>User specifications, features, functional requirements</p></li>
<li><p>Test fixtures and helpers</p></li>
<li><p>Module server function tests with <code>testServer()</code></p></li>
<li><p>System tests with <code>shinytest2</code></p></li>
</ul>


</section>
Expand Down
4 changes: 2 additions & 2 deletions comparisons.html
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,7 @@ <h3 class="anchored" data-anchor-id="waldo"><span style="font-size: 1.05em;"><co
<dl class="code-annotation-container-hidden code-annotation-container-grid">
<dt data-target-cell="annotated-cell-1" data-target-annotation="1">1</dt>
<dd>
<span data-code-annotation="1" data-code-cell="annotated-cell-1" data-code-lines="2,3">Comparing identical objects</span>
<span data-code-cell="annotated-cell-1" data-code-lines="2,3" data-code-annotation="1">Comparing identical objects</span>
</dd>
</dl>
</div>
Expand Down Expand Up @@ -481,7 +481,7 @@ <h3 class="anchored" data-anchor-id="waldo"><span style="font-size: 1.05em;"><co
<dl class="code-annotation-container-hidden code-annotation-container-grid">
<dt data-target-cell="annotated-cell-2" data-target-annotation="1">1</dt>
<dd>
<span data-code-annotation="1" data-code-cell="annotated-cell-2" data-code-lines="2,3">Comparing different objects</span>
<span data-code-cell="annotated-cell-2" data-code-lines="2,3" data-code-annotation="1">Comparing different objects</span>
</dd>
</dl>
</div>
Expand Down
2 changes: 1 addition & 1 deletion data.html
Original file line number Diff line number Diff line change
Expand Up @@ -748,7 +748,7 @@ <h3 class="anchored" data-anchor-id="using-movies">Using <code>movies</code></h3
<dl class="code-annotation-container-hidden code-annotation-container-grid">
<dt data-target-cell="annotated-cell-19" data-target-annotation="1">1</dt>
<dd>
<span data-code-lines="17" data-code-annotation="1" data-code-cell="annotated-cell-19">The <code>movies</code> data from our package namespace</span>
<span data-code-cell="annotated-cell-19" data-code-annotation="1" data-code-lines="17">The <code>movies</code> data from our package namespace</span>
</dd>
</dl>
</div>
Expand Down
36 changes: 18 additions & 18 deletions debugging.html
Original file line number Diff line number Diff line change
Expand Up @@ -485,12 +485,12 @@ <h3 class="anchored" data-anchor-id="observe"><span style="font-size: 0.95em;"><
<dl class="code-annotation-container-hidden code-annotation-container-grid">
<dt data-target-cell="annotated-cell-1" data-target-annotation="1">1</dt>
<dd>
<span data-code-lines="3,11" data-code-annotation="1" data-code-cell="annotated-cell-1"><code>observe()</code> function scope<br>
<span data-code-lines="3,11" data-code-cell="annotated-cell-1" data-code-annotation="1"><code>observe()</code> function scope<br>
</span>
</dd>
<dt data-target-cell="annotated-cell-1" data-target-annotation="2">2</dt>
<dd>
<span data-code-lines="4" data-code-annotation="2" data-code-cell="annotated-cell-1">Call to <code>browser()</code> (called at the top of the <code>observe()</code> scope)</span>
<span data-code-lines="4" data-code-cell="annotated-cell-1" data-code-annotation="2">Call to <code>browser()</code> (called at the top of the <code>observe()</code> scope)</span>
</dd>
</dl>
</div>
Expand Down Expand Up @@ -581,12 +581,12 @@ <h2 class="anchored" data-anchor-id="debugging-app-functions">Debugging app func
<dl class="code-annotation-container-hidden code-annotation-container-grid">
<dt data-target-cell="annotated-cell-6" data-target-annotation="1">1</dt>
<dd>
<span data-code-lines="3,10" data-code-annotation="1" data-code-cell="annotated-cell-6">Observer scope<br>
<span data-code-lines="3,10" data-code-cell="annotated-cell-6" data-code-annotation="1">Observer scope<br>
</span>
</dd>
<dt data-target-cell="annotated-cell-6" data-target-annotation="2">2</dt>
<dd>
<span data-code-lines="4" data-code-annotation="2" data-code-cell="annotated-cell-6">Activate debugger</span>
<span data-code-lines="4" data-code-cell="annotated-cell-6" data-code-annotation="2">Activate debugger</span>
</dd>
</dl>
</div>
Expand Down Expand Up @@ -756,7 +756,7 @@ <h2 class="anchored" data-anchor-id="debugging-modules">Debugging modules</h2>
<dl class="code-annotation-container-hidden code-annotation-container-grid">
<dt data-target-cell="annotated-cell-12" data-target-annotation="1">1</dt>
<dd>
<span data-code-lines="4,9" data-code-annotation="1" data-code-cell="annotated-cell-12">Wrap <code>browser()</code> in <code>observe()</code> and place after the call to <code>moduleServer()</code></span>
<span data-code-lines="4,9" data-code-cell="annotated-cell-12" data-code-annotation="1">Wrap <code>browser()</code> in <code>observe()</code> and place after the call to <code>moduleServer()</code></span>
</dd>
</dl>
</div>
Expand Down Expand Up @@ -830,12 +830,12 @@ <h3 class="anchored" data-anchor-id="verify-variable-inputs">Verify variable inp
<dl class="code-annotation-container-hidden code-annotation-container-grid">
<dt data-target-cell="annotated-cell-15" data-target-annotation="1">1</dt>
<dd>
<span data-code-lines="2,10" data-code-annotation="1" data-code-cell="annotated-cell-15">Variable inputs (from <code>selected_vars</code>)<br>
<span data-code-lines="2,10" data-code-cell="annotated-cell-15" data-code-annotation="1">Variable inputs (from <code>selected_vars</code>)<br>
</span>
</dd>
<dt data-target-cell="annotated-cell-15" data-target-annotation="2">2</dt>
<dd>
<span data-code-lines="1,11" data-code-annotation="2" data-code-cell="annotated-cell-15"><code>inputs()</code> for <code>scatter_plot()</code></span>
<span data-code-lines="1,11" data-code-cell="annotated-cell-15" data-code-annotation="2"><code>inputs()</code> for <code>scatter_plot()</code></span>
</dd>
</dl>
</div>
Expand Down Expand Up @@ -904,12 +904,12 @@ <h3 class="anchored" data-anchor-id="verify-graph">Verify graph</h3>
<dl class="code-annotation-container-hidden code-annotation-container-grid">
<dt data-target-cell="annotated-cell-16" data-target-annotation="1">1</dt>
<dd>
<span data-code-lines="2,6" data-code-annotation="1" data-code-cell="annotated-cell-16">Observe scope<br>
<span data-code-lines="2,6" data-code-cell="annotated-cell-16" data-code-annotation="1">Observe scope<br>
</span>
</dd>
<dt data-target-cell="annotated-cell-16" data-target-annotation="2">2</dt>
<dd>
<span data-code-lines="3" data-code-annotation="2" data-code-cell="annotated-cell-16">Call to <code>browser()</code></span>
<span data-code-lines="3" data-code-cell="annotated-cell-16" data-code-annotation="2">Call to <code>browser()</code></span>
</dd>
</dl>
</div>
Expand Down Expand Up @@ -992,7 +992,7 @@ <h6 class="anchored" data-anchor-id="section-3"></h6>
<dl class="code-annotation-container-hidden code-annotation-container-grid">
<dt data-target-cell="annotated-cell-2" data-target-annotation="1">1</dt>
<dd>
<span data-code-lines="8" data-code-annotation="1" data-code-cell="annotated-cell-2">Location of debugger in utility function</span>
<span data-code-lines="8" data-code-cell="annotated-cell-2" data-code-annotation="1">Location of debugger in utility function</span>
</dd>
</dl>
</div>
Expand Down Expand Up @@ -1050,17 +1050,17 @@ <h2 class="anchored" data-anchor-id="exploring-code">Exploring code</h2>
<dl class="code-annotation-container-hidden code-annotation-container-grid">
<dt data-target-cell="annotated-cell-19" data-target-annotation="1">1</dt>
<dd>
<span data-code-lines="4,13" data-code-annotation="1" data-code-cell="annotated-cell-19">Observer scope<br>
<span data-code-lines="4,13" data-code-cell="annotated-cell-19" data-code-annotation="1">Observer scope<br>
</span>
</dd>
<dt data-target-cell="annotated-cell-19" data-target-annotation="2">2</dt>
<dd>
<span data-code-lines="5" data-code-annotation="2" data-code-cell="annotated-cell-19">Call to <code>browser()</code><br>
<span data-code-lines="5" data-code-cell="annotated-cell-19" data-code-annotation="2">Call to <code>browser()</code><br>
</span>
</dd>
<dt data-target-cell="annotated-cell-19" data-target-annotation="3">3</dt>
<dd>
<span data-code-lines="9,10,11,12" data-code-annotation="3" data-code-cell="annotated-cell-19">Additional module code omitted</span>
<span data-code-lines="9,10,11,12" data-code-cell="annotated-cell-19" data-code-annotation="3">Additional module code omitted</span>
</dd>
</dl>
</div>
Expand Down Expand Up @@ -1275,12 +1275,12 @@ <h2 class="anchored" data-anchor-id="debugging-apps">Debugging apps</h2>
<dl class="code-annotation-container-hidden code-annotation-container-grid">
<dt data-target-cell="annotated-cell-22" data-target-annotation="1">1</dt>
<dd>
<span data-code-lines="1" data-code-annotation="1" data-code-cell="annotated-cell-22">Optional label<br>
<span data-code-lines="1" data-code-cell="annotated-cell-22" data-code-annotation="1">Optional label<br>
</span>
</dd>
<dt data-target-cell="annotated-cell-22" data-target-annotation="2">2</dt>
<dd>
<span data-code-lines="2" data-code-annotation="2" data-code-cell="annotated-cell-22">Include the <code>ns()</code> for the <code>inputId</code></span>
<span data-code-lines="2" data-code-cell="annotated-cell-22" data-code-annotation="2">Include the <code>ns()</code> for the <code>inputId</code></span>
</dd>
</dl>
</div>
Expand All @@ -1301,17 +1301,17 @@ <h2 class="anchored" data-anchor-id="debugging-apps">Debugging apps</h2>
<dl class="code-annotation-container-hidden code-annotation-container-grid">
<dt data-target-cell="annotated-cell-23" data-target-annotation="1">1</dt>
<dd>
<span data-code-lines="3,6" data-code-annotation="1" data-code-cell="annotated-cell-23">Collect reactive values in module<br>
<span data-code-lines="3,6" data-code-cell="annotated-cell-23" data-code-annotation="1">Collect reactive values in module<br>
</span>
</dd>
<dt data-target-cell="annotated-cell-23" data-target-annotation="2">2</dt>
<dd>
<span data-code-lines="2,7" data-code-annotation="2" data-code-cell="annotated-cell-23">Print these values to the UI<br>
<span data-code-lines="2,7" data-code-cell="annotated-cell-23" data-code-annotation="2">Print these values to the UI<br>
</span>
</dd>
<dt data-target-cell="annotated-cell-23" data-target-annotation="3">3</dt>
<dd>
<span data-code-lines="5" data-code-annotation="3" data-code-cell="annotated-cell-23">Include all reactive objects</span>
<span data-code-lines="5" data-code-cell="annotated-cell-23" data-code-annotation="3">Include all reactive objects</span>
</dd>
</dl>
</div>
Expand Down
2 changes: 1 addition & 1 deletion dependencies.html
Original file line number Diff line number Diff line change
Expand Up @@ -533,7 +533,7 @@ <h2 class="anchored" data-anchor-id="moviesapp"><span style="font-size: 1.05em">
<dl class="code-annotation-container-hidden code-annotation-container-grid">
<dt data-target-cell="annotated-cell-1" data-target-annotation="1">1</dt>
<dd>
<span data-code-cell="annotated-cell-1" data-code-annotation="1" data-code-lines="13,21">The <code>man</code> folder now contains the help (<code>.Rd</code>) files for the functions in <code>R/</code></span>
<span data-code-lines="13,21" data-code-annotation="1" data-code-cell="annotated-cell-1">The <code>man</code> folder now contains the help (<code>.Rd</code>) files for the functions in <code>R/</code></span>
</dd>
</dl>
</div>
Expand Down
2 changes: 1 addition & 1 deletion development.html
Original file line number Diff line number Diff line change
Expand Up @@ -824,7 +824,7 @@ <h6 class="anchored" data-anchor-id="section-3"></h6>
<p><img src="img/new_branch_ico.png" class="img-fluid figure-img" style="width:75.0%"></p>
</figure>
</div>
<p>This section’s code is in the <a href="https://github.com/mjfrigaard/moviesApp/tree/06_devtools"><code>06_devtools</code></a> branch of <a href="https://github.com/mjfrigaard/moviesApp"><code>moviesApp</code></a>.</p>
<p>This section’s code is in the <a href="https://github.com/mjfrigaard/moviesApp/tree/06b_devtools"><code>06b_devtools</code></a> branch of <a href="https://github.com/mjfrigaard/moviesApp"><code>moviesApp</code></a>.</p>
</div></div></section>
<section id="check" class="level3">
<h3 class="anchored" data-anchor-id="check"><span style="font-weight: bold;">Check?</span></h3>
Expand Down
2 changes: 1 addition & 1 deletion document.html
Original file line number Diff line number Diff line change
Expand Up @@ -572,7 +572,7 @@ <h3 class="anchored" data-anchor-id="markdown-true"><span style="font-size: 0.90
<dl class="code-annotation-container-hidden code-annotation-container-grid">
<dt data-target-cell="annotated-cell-3" data-target-annotation="1">1</dt>
<dd>
<span data-code-cell="annotated-cell-3" data-code-annotation="1" data-code-lines="13">Always leave at least one empty final line in your <code>DESCRIPTION</code> file.</span>
<span data-code-annotation="1" data-code-lines="13" data-code-cell="annotated-cell-3">Always leave at least one empty final line in your <code>DESCRIPTION</code> file.</span>
</dd>
</dl>
</div>
Expand Down
Loading

0 comments on commit 46448e0

Please sign in to comment.