Deploying to gh-pages from @ df6d545 🚀

js2264 · Aug 8, 2023 · 73aea99 · 73aea99
1 parent 7e0ca17
commit 73aea99
Show file tree

Hide file tree

Showing 5 changed files with 124 additions and 52 deletions.
diff --git a/docs/devel/index.html b/docs/devel/index.html
@@ -230,7 +230,7 @@ <h1 class="title">Writing reproducible books with Bioconductor</h1>
 <p><strong>Package:</strong> BiocBook<br><strong>Authors:</strong> First Last [aut, cre]<br><strong>Version:</strong> 0.99.0<br><strong>Modified:</strong> 2023-08-03<br><strong>Compiled:</strong> 2023-08-08<br><strong>Environment:</strong> R version 4.3.1 (2023-06-16), Bioconductor 3.18<br><strong>License:</strong> MIT + file LICENSE<br><strong>Copyright:</strong> Bioconductor, 2023</p>
 <p>This is the landing page of the <code>BiocBook</code> entitled <em>Write, containerize, publish and versionize Quarto books with Bioconductor</em>.</p>
 <p>This book introduces the reader to the <code>BiocBook</code> <strong>package</strong> and the auto-generated, versionized <strong>Docker images</strong> and <strong>website</strong>.</p>
-<p><img src="../inst/assets/workflow.png" class="img-fluid" style="width:50.0%"></p>
+<p><img src="../inst/img/workflow.png" class="img-fluid" style="width:50.0%"></p>
 </section><section id="docker-image" class="level1 unnumbered"><h1 class="unnumbered">Docker image</h1>
 <p>A <code>Docker</code> image built from this repository is available here:</p>
 <p>👉 <a href="https://ghcr.io/js2264/biocbook">ghcr.io/js2264/biocbook</a> 🐳</p>

diff --git a/docs/devel/inst/img/workflow.png b/docs/devel/inst/img/workflow.png
diff --git a/docs/devel/pages/Chapter-4.html b/docs/devel/pages/Chapter-4.html
@@ -1,12 +1,9 @@
 <!DOCTYPE html>
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
-
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta charset="utf-8">
 <meta name="generator" content="quarto-1.3.450">
-
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
-
-
 <title>Writing reproducible books with Bioconductor - 4&nbsp; Containerize and Publish against specific Bioconductor release versions</title>
 <style>
 code{white-space: pre-wrap;}
@@ -20,9 +17,42 @@
   margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */ 
   vertical-align: middle;
 }
+/* CSS for syntax highlighting */
+pre > code.sourceCode { white-space: pre; position: relative; }
+pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
+pre > code.sourceCode > span:empty { height: 1.2em; }
+.sourceCode { overflow: visible; }
+code.sourceCode > span { color: inherit; text-decoration: inherit; }
+div.sourceCode { margin: 1em 0; }
+pre.sourceCode { margin: 0; }
+@media screen {
+div.sourceCode { overflow: auto; }
+}
+@media print {
+pre > code.sourceCode { white-space: pre-wrap; }
+pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
+}
+pre.numberSource code
+  { counter-reset: source-line 0; }
+pre.numberSource code > span
+  { position: relative; left: -4em; counter-increment: source-line; }
+pre.numberSource code > span > a:first-child::before
+  { content: counter(source-line);
+    position: relative; left: -1em; text-align: right; vertical-align: baseline;
+    border: none; display: inline-block;
+    -webkit-touch-callout: none; -webkit-user-select: none;
+    -khtml-user-select: none; -moz-user-select: none;
+    -ms-user-select: none; user-select: none;
+    padding: 0 4px; width: 4em;
+  }
+pre.numberSource { margin-left: 3em;  padding-left: 4px; }
+div.sourceCode
+  {   }
+@media screen {
+pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
+}
 </style>
 
-
 <script src="../site_libs/quarto-nav/quarto-nav.js"></script>
 <script src="../site_libs/quarto-nav/headroom.min.js"></script>
 <script src="../site_libs/clipboard/clipboard.min.js"></script>
@@ -40,8 +70,7 @@
 <link href="../site_libs/quarto-html/quarto-syntax-highlighting.css" rel="stylesheet" id="quarto-text-highlighting-styles">
 <script src="../site_libs/bootstrap/bootstrap.min.js"></script>
 <link href="../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
-<link href="../site_libs/bootstrap/bootstrap.min.css" rel="stylesheet" id="quarto-bootstrap" data-mode="light">
-<script id="quarto-search-options" type="application/json">{
+<link href="../site_libs/bootstrap/bootstrap.min.css" rel="stylesheet" id="quarto-bootstrap" data-mode="light"><script id="quarto-search-options" type="application/json">{
   "location": "sidebar",
   "copy-button": false,
   "collapse-after": 3,
@@ -61,18 +90,14 @@
     "search-label": "Search"
   }
 }</script>
-
-
 <meta property="og:title" content="Writing reproducible books with Bioconductor - 4&nbsp; Containerize and Publish against specific Bioconductor release versions">
+<meta property="og:description" content="">
 <meta property="og:site-name" content="Writing reproducible books with Bioconductor">
 </head>
-
 <body class="nav-sidebar docked">
 
 <div id="quarto-search-results"></div>
-  <header id="quarto-header" class="headroom fixed-top">
-  <nav class="quarto-secondary-nav">
-    <div class="container-fluid d-flex">
+  <header id="quarto-header" class="headroom fixed-top"><nav class="quarto-secondary-nav"><div class="container-fluid d-flex">
       <button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
         <i class="bi bi-layout-text-sidebar-reverse"></i>
       </button>
@@ -83,20 +108,16 @@
         <i class="bi bi-search"></i>
       </button>
     </div>
-  </nav>
-</header>
-<!-- content -->
-<div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article">
+  </nav></header><!-- content --><div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article">
 <!-- sidebar -->
-  <nav id="quarto-sidebar" class="sidebar collapse collapse-horizontal sidebar-navigation docked overflow-auto">
-    <div class="pt-lg-2 mt-2 text-left sidebar-header">
+  <nav id="quarto-sidebar" class="sidebar collapse collapse-horizontal sidebar-navigation docked overflow-auto"><div class="pt-lg-2 mt-2 text-left sidebar-header">
     <div class="sidebar-title mb-0 py-0">
       <a href="../">Writing reproducible books with Bioconductor</a> 
         <div class="sidebar-tools-main">
     <div class="dropdown">
       <a href="" title="" id="quarto-navigation-tool-dropdown-0" class="quarto-navigation-tool dropdown-toggle px-1" data-bs-toggle="dropdown" aria-expanded="false" aria-label=""><i class="bi bi-git"></i></a>
       <ul class="dropdown-menu" aria-labelledby="quarto-navigation-tool-dropdown-0">
-          <li>
+<li>
             <a class="dropdown-item sidebar-tools-main-item" href="https://github.com/js2264/BiocBook/">
             Source Code
             </a>
@@ -107,7 +128,7 @@
             </a>
           </li>
       </ul>
-    </div>
+</div>
 </div>
     </div>
       </div>
@@ -118,7 +139,7 @@
         </div>
     <div class="sidebar-menu-container"> 
     <ul class="list-unstyled mt-1">
-        <li class="sidebar-item">
+<li class="sidebar-item">
   <div class="sidebar-item-container"> 
   <a href="../index.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Welcome</span></a>
@@ -155,19 +176,22 @@
   </div>
 </li>
     </ul>
-    </div>
-</nav>
-<div id="quarto-sidebar-glass" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass"></div>
+</div>
+</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">Table of contents</h2>
+
+  <ul>
+<li><a href="#for-a-biocbook-package-not-currently-in-bioconductor" id="toc-for-a-biocbook-package-not-currently-in-bioconductor" class="nav-link active" data-scroll-target="#for-a-biocbook-package-not-currently-in-bioconductor"><span class="header-section-number">4.1</span> For a <code>BiocBook</code> package not currently in Bioconductor</a></li>
+  <li><a href="#for-a-biocbook-package-accepted-in-bioconductor-6-months-ago" id="toc-for-a-biocbook-package-accepted-in-bioconductor-6-months-ago" class="nav-link" data-scroll-target="#for-a-biocbook-package-accepted-in-bioconductor-6-months-ago"><span class="header-section-number">4.2</span> For a <code>BiocBook</code> package accepted in Bioconductor &gt; 6 months ago</a></li>
+  </ul></nav>
     </div>
 <!-- main -->
-<main class="content" id="quarto-document-content">
-
-<header id="title-block-header" class="quarto-title-block default">
-<div class="quarto-title">
-<h1 class="title"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Containerize and Publish against specific Bioconductor release versions</span></h1>
+<main class="content" id="quarto-document-content"><header id="title-block-header" class="quarto-title-block default"><div class="quarto-title">
+<h1 class="title">
+<span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Containerize and Publish against specific Bioconductor release versions</span>
+</h1>
 </div>
 
 
@@ -180,13 +204,58 @@ <h1 class="title"><span class="chapter-number">4</span>&nbsp; <span class="chapt
   </div>
 
 
-</header>
-
-
+</header><section id="for-a-biocbook-package-not-currently-in-bioconductor" class="level2" data-number="4.1"><h2 data-number="4.1" class="anchored" data-anchor-id="for-a-biocbook-package-not-currently-in-bioconductor">
+<span class="header-section-number">4.1</span> For a <code>BiocBook</code> package not currently in Bioconductor</h2>
+<p>One can build against older Bioconductor releases as follows:</p>
+<ul>
+<li>Commit current changes before switching branches (should be in <code>devel</code> branch)</li>
+</ul>
+<div class="cell" data-layout-align="center">
+<div class="sourceCode" id="cb1"><pre class="downlit sourceCode r code-with-copy"><code class="sourceCode R"><span><span class="fu">gert</span><span class="fu">::</span><span class="fu"><a href="https://docs.ropensci.org/gert/reference/git_commit.html">git_commit_all</a></span><span class="op">(</span><span class="st">"Commit current changes"</span><span class="op">)</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
+</div>
+<ul>
+<li>Create a new branch named <code>RELEASE_X_Y</code> and checkout</li>
+</ul>
+<div class="cell" data-layout-align="center">
+<div class="sourceCode" id="cb2"><pre class="downlit sourceCode r code-with-copy"><code class="sourceCode R"><span><span class="fu">gert</span><span class="fu">::</span><span class="fu"><a href="https://docs.ropensci.org/gert/reference/git_branch.html">git_branch_create</a></span><span class="op">(</span><span class="st">"RELEASE_3_17"</span><span class="op">)</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
+</div>
+<ul>
+<li>Push local <code>RELEASE_X_Y</code> to Github</li>
+</ul>
+<div class="cell" data-layout-align="center">
+<div class="sourceCode" id="cb3"><pre class="downlit sourceCode r code-with-copy"><code class="sourceCode R"><span><span class="fu">gert</span><span class="fu">::</span><span class="fu"><a href="https://docs.ropensci.org/gert/reference/git_fetch.html">git_push</a></span><span class="op">(</span><span class="op">)</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
+</div>
+</section><section id="for-a-biocbook-package-accepted-in-bioconductor-6-months-ago" class="level2" data-number="4.2"><h2 data-number="4.2" class="anchored" data-anchor-id="for-a-biocbook-package-accepted-in-bioconductor-6-months-ago">
+<span class="header-section-number">4.2</span> For a <code>BiocBook</code> package accepted in Bioconductor &gt; 6 months ago</h2>
+<p>Once your package is accepted in Bioconductor, your repository will have access to a new <strong>remote</strong> named <code>upstream</code>, pointing to <code>git@git.bioconductor.org</code>. When Bioconductor releases a new version, your package will change version on the <code>upstream</code> remote, in a dedicated release branch <code>RELEASE_X_Y</code>. All details are available <a href="https://contributions.bioconductor.org/git-version-control.html">here</a>.</p>
+<p>To generate a Docker image and a version of the <code>BiocBook</code> website built on new Bioconductor releases, you can:</p>
+<ul>
+<li>Add the <code>Bioconductor</code> remote to your local repository (this might already be set up)</li>
+</ul>
+<div class="cell" data-layout-align="center">
+<div class="sourceCode" id="cb4"><pre class="downlit sourceCode r code-with-copy"><code class="sourceCode R"><span><span class="fu">gert</span><span class="fu">::</span><span class="fu"><a href="https://docs.ropensci.org/gert/reference/git_remote.html">git_remote_add</a></span><span class="op">(</span>name <span class="op">=</span> <span class="st">'upstream'</span>, url <span class="op">=</span> <span class="st">'git@git.bioconductor.org:packages/&lt;YOUR-REPOSITORY&gt;.git'</span><span class="op">)</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
+</div>
+<ul>
+<li>Create a new local <code>RELEASE_X_Y</code> branch</li>
+</ul>
+<div class="cell" data-layout-align="center">
+<div class="sourceCode" id="cb5"><pre class="downlit sourceCode r code-with-copy"><code class="sourceCode R"><span><span class="fu">gert</span><span class="fu">::</span><span class="fu"><a href="https://docs.ropensci.org/gert/reference/git_branch.html">git_branch_create</a></span><span class="op">(</span><span class="st">"RELEASE_3_15"</span><span class="op">)</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
+</div>
+<ul>
+<li>Pull the <code>upstream</code> <code>RELEASE_X_Y</code> commits</li>
+</ul>
+<div class="cell" data-layout-align="center">
+<div class="sourceCode" id="cb6"><pre class="downlit sourceCode r code-with-copy"><code class="sourceCode R"><span><span class="fu">gert</span><span class="fu">::</span><span class="fu"><a href="https://docs.ropensci.org/gert/reference/git_fetch.html">git_pull</a></span><span class="op">(</span><span class="st">"RELEASE_3_15"</span>, remote <span class="op">=</span> <span class="st">"upstream"</span><span class="op">)</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
+</div>
+<ul>
+<li>Push the local <code>RELEASE_X_Y</code> branch to <code>origin</code> remote (your own Github repository)</li>
+</ul>
+<div class="cell" data-layout-align="center">
+<div class="sourceCode" id="cb7"><pre class="downlit sourceCode r code-with-copy"><code class="sourceCode R"><span><span class="fu">gert</span><span class="fu">::</span><span class="fu"><a href="https://docs.ropensci.org/gert/reference/git_fetch.html">git_push</a></span><span class="op">(</span><span class="st">"RELEASE_3_15"</span>, remote <span class="op">=</span> <span class="st">"origin"</span><span class="op">)</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
+</div>
 
 
-<a onclick="window.scrollTo(0, 0); return false;" role="button" id="quarto-back-to-top"><i class="bi bi-arrow-up"></i> Back to top</a></main> <!-- /main -->
-<script id="quarto-html-after-body" type="application/javascript">
+</section><a onclick="window.scrollTo(0, 0); return false;" role="button" id="quarto-back-to-top"><i class="bi bi-arrow-up"></i> Back to top</a></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");
@@ -418,9 +487,7 @@ <h1 class="title"><span class="chapter-number">4</span>&nbsp; <span class="chapt
     }
   }
 });
-</script>
-<nav class="page-navigation">
-  <div class="nav-page nav-page-previous">
+</script><nav class="page-navigation"><div class="nav-page nav-page-previous">
       <a href="../pages/Chapter-3.html" class="pagination-link">
         <i class="bi bi-arrow-left-short"></i> <span class="nav-page-text"><span class="chapter-number">3</span>&nbsp; <span class="chapter-title">Publish a <code>BiocBook</code> package as a website</span></span>
       </a>          
@@ -429,8 +496,7 @@ <h1 class="title"><span class="chapter-number">4</span>&nbsp; <span class="chapt
   </div>
 </nav>
 </div> <!-- /content -->
-<footer class="footer">
-  <div class="nav-footer">
+<footer class="footer"><div class="nav-footer">
     <div class="nav-footer-left">This book was built with <a href="https://github.com/js2264/BiocBook/">BiocBook</a> with <span class="emoji" data-emoji="heart">❤️</span></div>   
     <div class="nav-footer-center">
       &nbsp;
@@ -442,5 +508,4 @@ <h1 class="title"><span class="chapter-number">4</span>&nbsp; <span class="chapt
 </footer>
 
 
-
 </body></html>
diff --git a/docs/devel/pages/preamble.html b/docs/devel/pages/preamble.html
@@ -93,7 +93,7 @@
 }</script>
 <meta property="og:title" content="Writing reproducible books with Bioconductor - Preamble">
 <meta property="og:description" content="">
-<meta property="og:image" content="../inst/assets/workflow.png">
+<meta property="og:image" content="../inst/img/workflow.png">
 <meta property="og:site-name" content="Writing reproducible books with Bioconductor">
 </head>
 <body class="nav-sidebar docked">
@@ -246,7 +246,7 @@ <h1 class="title">Preamble</h1>
 
 </div>
 </div>
-<p><img src="../inst/assets/workflow.png" class="img-fluid" style="width:50.0%"></p>
+<p><img src="../inst/img/workflow.png" class="img-fluid" style="width:50.0%"></p>
 <p>In this website, a <code>BiocBook</code> can refer to the <strong>package</strong>, the <strong>Docker image</strong> or the <strong>website</strong>. We will make our best to clarify from this point forward.</p>
 </section><section id="mechanics" class="level2"><h2 class="anchored" data-anchor-id="mechanics">Mechanics</h2>
 <section id="first-things-first" class="level3"><h3 class="anchored" data-anchor-id="first-things-first">First things first</h3>
@@ -330,7 +330,7 @@ <h1 class="title">Preamble</h1>
 </div>
 </section><section id="so-what-packages-can-i-use" class="level2"><h2 class="anchored" data-anchor-id="so-what-packages-can-i-use">So what packages can I use?</h2>
 <p>Any package that has been released in the Bioconductor version you are using (in this book version, this is 3.18).</p>
-<p>The <code>HiContacts</code> package is available in Bioconductor since <code>3.16</code>, while the <code>HiCExperiment</code> package was only made available in <code>3.17</code>. <code>MICSQTL</code> has recently been accepted in <code>3.18</code> (current <code>devel</code>, on Tue Aug 8 08:02:29 2023). Let’s check this!</p>
+<p>The <code>HiContacts</code> package is available in Bioconductor since <code>3.16</code>, while the <code>HiCExperiment</code> package was only made available in <code>3.17</code>. <code>MICSQTL</code> has recently been accepted in <code>3.18</code> (current <code>devel</code>, on Tue Aug 8 08:51:28 2023). Let’s check this!</p>
 <div class="cell" data-layout-align="center">
 <div class="sourceCode" id="cb3"><pre class="downlit sourceCode r code-with-copy"><code class="sourceCode R"><span><span class="fu">BiocManager</span><span class="fu">::</span><span class="fu"><a href="https://bioconductor.github.io/BiocManager/reference/available.html">available</a></span><span class="op">(</span><span class="st">"HiContacts"</span><span class="op">)</span></span>
 <span><span class="co">##  'getOption("repos")' replaces Bioconductor standard repositories, see</span></span>