Built site for gh-pages

mjfrigaard · Aug 18, 2023 · c23809d · c23809d
1 parent a7048bf
commit c23809d
Show file tree

Hide file tree

Showing 31 changed files with 1,673 additions and 625 deletions.
diff --git a/.nojekyll b/.nojekyll
@@ -1 +1 @@
-3c4d1cbb
+92bdda7b
diff --git a/app_packages.html b/app_packages.html
@@ -262,6 +262,12 @@
   <a href="./github.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">GitHub</span></a>
   </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="./create.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Appendix: Creating packages in Posit Workbench</span></a>
+  </div>
 </li>
       </ul>
 </li>

diff --git a/code_tools.html b/code_tools.html
@@ -262,6 +262,12 @@
   <a href="./github.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">GitHub</span></a>
   </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="./create.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Appendix: Creating packages in Posit Workbench</span></a>
+  </div>
 </li>
       </ul>
 </li>

diff --git a/create.html b/create.html
diff --git a/css.html b/css.html
@@ -262,6 +262,12 @@
   <a href="./github.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">GitHub</span></a>
   </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="./create.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Appendix: Creating packages in Posit Workbench</span></a>
+  </div>
 </li>
       </ul>
 </li>

diff --git a/data.html b/data.html
diff --git a/debugging.html b/debugging.html
@@ -262,6 +262,12 @@
   <a href="./github.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">GitHub</span></a>
   </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="./create.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Appendix: Creating packages in Posit Workbench</span></a>
+  </div>
 </li>
       </ul>
 </li>

diff --git a/dependencies.html b/dependencies.html
diff --git a/devtools.html b/devtools.html
@@ -296,6 +296,12 @@
   <a href="./github.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">GitHub</span></a>
   </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="./create.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Appendix: Creating packages in Posit Workbench</span></a>
+  </div>
 </li>
       </ul>
 </li>
@@ -354,13 +360,13 @@ <h1 class="title"><span style="font-size: 1.05em;"><code>devtools</code></span><
 </div>
 </div>
 </div>
-<p>The previous chapter covered how to create new or convert existing shiny app projects into app-packages with <code><a href="https://usethis.r-lib.org/reference/create_package.html">usethis::create_package()</a></code>. We also manually transformed a shiny project into an app-package by adding specific fields to the <code>DESCRIPTION</code> file.</p>
-<p>Regardless of the method we use to start our app-package, if we want it to be ‘functional’, we need to install the <a href="https://devtools.r-lib.org/"><code>devtools</code> package</a>.</p>
+<p>The previous chapter covered what files are needed to create R packages and app-packages, how to create new or convert existing shiny app projects into app-packages with <code><a href="https://usethis.r-lib.org/reference/create_package.html">usethis::create_package()</a></code>.</p>
+<p>After setting up the <code>DESCRIPTION</code> file and configuring the package <strong>Build Tools</strong>, we’ll need to test it’s ‘functionality’ with the <a href="https://devtools.r-lib.org/"><code>devtools</code> package</a>.</p>
 <div class="cell">
 <div class="sourceCode" id="cb1"><pre class="downlit sourceCode r code-with-copy"><code class="sourceCode R"><span><span class="fu"><a href="https://rdrr.io/r/utils/install.packages.html">install.packages</a></span><span class="op">(</span><span class="st">"devtools"</span><span class="op">)</span></span>
 <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://devtools.r-lib.org/">devtools</a></span><span class="op">)</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
 </div>
-<p>By ‘functional’, I mean that the app-package manages dependencies and has documentation in addition to storing code and data.</p>
+<p>By ‘functionality’, I mean the app-package can call the <code>devtools</code> functions for loading the code in <code>R/</code>, creating documentation, and successfully installing the package from the source files.</p>
 <p>Let’s get started!</p>
 <section id="developing-with-devtools" class="level2"><h2 class="anchored" data-anchor-id="developing-with-devtools">Developing with <span style="font-size: 1.10em"><code>devtools</code></span>
 </h2>

diff --git a/frameworks.html b/frameworks.html
@@ -262,6 +262,12 @@
   <a href="./github.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">GitHub</span></a>
   </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="./create.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Appendix: Creating packages in Posit Workbench</span></a>
+  </div>
 </li>
       </ul>
 </li>

diff --git a/github.html b/github.html
@@ -61,6 +61,7 @@
 <script src="site_libs/quarto-search/fuse.min.js"></script>
 <script src="site_libs/quarto-search/quarto-search.js"></script>
 <meta name="quarto:offset" content="./">
+<link href="./create.html" rel="next">
 <link href="./glossary.html" rel="prev">
 <script src="site_libs/quarto-html/quarto.js"></script>
 <script src="site_libs/quarto-html/popper.min.js"></script>
@@ -295,6 +296,12 @@
   <a href="./github.html" class="sidebar-item-text sidebar-link active">
  <span class="menu-text">GitHub</span></a>
   </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="./create.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Appendix: Creating packages in Posit Workbench</span></a>
+  </div>
 </li>
       </ul>
 </li>
@@ -864,6 +871,9 @@ <h1 class="title">GitHub</h1>
       </a>          
   </div>
   <div class="nav-page nav-page-next">
+      <a href="./create.html" class="pagination-link">
+        <span class="nav-page-text">Appendix: Creating packages in Posit Workbench</span> <i class="bi bi-arrow-right-short"></i>
+      </a>
   </div>
 </nav>
 </div> <!-- /content -->

diff --git a/glossary.html b/glossary.html
@@ -18,26 +18,7 @@
   margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */ 
   vertical-align: middle;
 }
-/* CSS for citations */
-div.csl-bib-body { }
-div.csl-entry {
-  clear: both;
-}
-.hanging-indent div.csl-entry {
-  margin-left:2em;
-  text-indent:-2em;
-}
-div.csl-left-margin {
-  min-width:2em;
-  float:left;
-}
-div.csl-right-inline {
-  margin-left:2em;
-  padding-left:1em;
-}
-div.csl-indent {
-  margin-left: 2em;
-}</style>
+</style>
 
 <script src="site_libs/quarto-nav/quarto-nav.js"></script>
 <script src="site_libs/quarto-nav/headroom.min.js"></script>
@@ -281,6 +262,12 @@
   <a href="./github.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">GitHub</span></a>
   </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="./create.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Appendix: Creating packages in Posit Workbench</span></a>
+  </div>
 </li>
       </ul>
 </li>
@@ -289,7 +276,28 @@
 </nav><div id="quarto-sidebar-glass" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass"></div>
 <!-- margin-sidebar -->
     <div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
-
+        <nav id="TOC" role="doc-toc" class="toc-active"><h2 id="toc-title">Contents</h2>
+
+  <ul>
+<li>
+<a href="#shiny-apps" id="toc-shiny-apps" class="nav-link active" data-scroll-target="#shiny-apps">Shiny apps</a>
+  <ul>
+<li><a href="#utilityhelper-functions" id="toc-utilityhelper-functions" class="nav-link" data-scroll-target="#utilityhelper-functions">Utility/helper functions</a></li>
+  <li><a href="#external-resources" id="toc-external-resources" class="nav-link" data-scroll-target="#external-resources">External resources</a></li>
+  <li><a href="#module" id="toc-module" class="nav-link" data-scroll-target="#module">Module</a></li>
+  <li><a href="#standalone-app-function" id="toc-standalone-app-function" class="nav-link" data-scroll-target="#standalone-app-function">Standalone app function</a></li>
+  </ul>
+</li>
+  <li>
+<a href="#packages" id="toc-packages" class="nav-link" data-scroll-target="#packages">Packages</a>
+  <ul>
+<li><a href="#project" id="toc-project" class="nav-link" data-scroll-target="#project">Project</a></li>
+  <li><a href="#package" id="toc-package" class="nav-link" data-scroll-target="#package">Package</a></li>
+  <li><a href="#app-package" id="toc-app-package" class="nav-link" data-scroll-target="#app-package">App-package</a></li>
+  </ul>
+</li>
+  <li><a href="#devtools" id="toc-devtools" class="nav-link" data-scroll-target="#devtools"><span style="font-size: 1.05em;"><code>devtools</code></span></a></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/glossary.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>
     </div>
 <!-- main -->
 <main class="content" id="quarto-document-content"><header id="title-block-header" class="quarto-title-block default"><div class="quarto-title">
@@ -324,14 +332,23 @@ <h1 class="title">Glossary of terms</h1>
 </div>
 </div>
 </div>
-<div id="refs" role="list" style="display: none">
-
-</div>
+<section id="shiny-apps" class="level2"><h2 class="anchored" data-anchor-id="shiny-apps">Shiny apps</h2>
+<section id="utilityhelper-functions" class="level3"><h3 class="anchored" data-anchor-id="utilityhelper-functions">Utility/helper functions</h3>
+</section><section id="external-resources" class="level3"><h3 class="anchored" data-anchor-id="external-resources">External resources</h3>
+</section><section id="module" class="level3"><h3 class="anchored" data-anchor-id="module">Module</h3>
+</section><section id="standalone-app-function" class="level3"><h3 class="anchored" data-anchor-id="standalone-app-function">Standalone app function</h3>
+</section></section><section id="packages" class="level2"><h2 class="anchored" data-anchor-id="packages">Packages</h2>
+<section id="project" class="level3"><h3 class="anchored" data-anchor-id="project">Project</h3>
+<p>Any directory of <a href="https://cran.r-project.org/">R executable files</a> with an RStudio/Posit workbench project file (<code>.Rproj</code>).</p>
+</section><section id="package" class="level3"><h3 class="anchored" data-anchor-id="package">Package</h3>
+<p>A directory of functions, documentation, and/or data can be installed and loaded into an R session. Packages include the necessary dependency management (<code>NAMESPACE</code>) and metadata files (<code>DESCRIPTION</code>) <em>and</em> has access to the package development tools in RStudio/Posit Workbench.</p>
+</section><section id="app-package" class="level3"><h3 class="anchored" data-anchor-id="app-package">App-package</h3>
+<p>An app-package is a package containing a shiny application. App-packages have all of the functionality of a standard R package, but also contain the files and folders required to successfully develop, run, and deploy a shiny application.</p>
+</section></section><section id="devtools" class="level2"><h2 class="anchored" data-anchor-id="devtools"><span style="font-size: 1.05em;"><code>devtools</code></span></h2>
 <p>end <code>glossary.qmd</code></p>
 
 
-
-</main><!-- /main --><script id="quarto-html-after-body" type="application/javascript">
+</section></main><!-- /main --><script id="quarto-html-after-body" type="application/javascript">
 window.document.addEventListener("DOMContentLoaded", function (event) {
   const toggleBodyColorMode = (bsSheetEl) => {
     const mode = bsSheetEl.getAttribute("data-mode");
@@ -693,4 +710,4 @@ <h1 class="title">Glossary of terms</h1>
 
 
 
-<footer class="footer"><div class="nav-footer"><div class="nav-footer-center"><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/glossary.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></div></div></footer></body></html>
+</body></html>
diff --git a/golem.html b/golem.html
@@ -296,6 +296,12 @@
   <a href="./github.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">GitHub</span></a>
   </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="./create.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Appendix: Creating packages in Posit Workbench</span></a>
+  </div>
 </li>
       </ul>
 </li>

diff --git a/img/shiny_app_ide_desc.png b/img/shiny_app_ide_desc.png
diff --git a/img/shiny_app_pkg_ide_desc_no_build.png b/img/shiny_app_pkg_ide_desc_no_build.png
diff --git a/img/terminate_session.png b/img/terminate_session.png
diff --git a/img/terminate_yes.png b/img/terminate_yes.png
diff --git a/index.html b/index.html
@@ -263,6 +263,12 @@
   <a href="./github.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">GitHub</span></a>
   </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="./create.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Appendix: Creating packages in Posit Workbench</span></a>
+  </div>
 </li>
       </ul>
 </li>
@@ -421,7 +427,7 @@ <h1 class="title">Shiny App-Packages</h1>
 <p>This book isn’t a replacement for <a href="https://r-pkgs.org/">R Packages, 2ed</a> or <a href="https://cran.r-project.org/doc/manuals/R-exts.html">Writing R Extensions</a>. I highly suggest bookmarking both of those resources to come back and read when you’d like to learn more about package development.</p>
 <p>This book also won’t recommend a particular Shiny framework or package, but I’ll cover a few popular choices and why you might consider adopting them.</p>
 </section><section id="what-i-assume-about-you" class="level2"><h2 class="anchored" data-anchor-id="what-i-assume-about-you">What I assume about you</h2>
-<p>If you’re reading this, I assume you’re comfortable with R, RStudio, Shiny, and the tidyverse. Maybe you haven’t built a ton of applications, but you understand reactivity, and you’re comfortable with the core Shiny concepts (i.e., the UI, server, <code>*_Input()</code>, <code>*_Output()</code>, and <code>render_</code>* functions, etc.).</p>
+<p>If you’re reading this, I assume you’re comfortable with R, Posit Workbench, Shiny, and the tidyverse. Maybe you haven’t built a ton of applications, but you understand reactivity, and you’re comfortable with the core Shiny concepts (i.e., the UI, server, <code>*_Input()</code>, <code>*_Output()</code>, and <code>render_</code>* functions, etc.).</p>
 </section><section id="other-resources" class="level2"><h2 class="anchored" data-anchor-id="other-resources">Other resources</h2>
 <p>Excellent resources have been written for <a href="https://shiny.posit.co/r/articles/">Shiny</a>, and it’s also worthwhile to consult the documentation on the core package development tools:</p>
 <ol type="1">