Render bookdown

jhudsl · Aug 23, 2024 · 0b6e17f · 0b6e17f
1 parent de265ca
commit 0b6e17f
Show file tree

Hide file tree

Showing 19 changed files with 223 additions and 161 deletions.
diff --git a/docs/07-using_platforms_modules.md b/docs/07-using_platforms_modules.md
@@ -8,6 +8,7 @@ Modules about opening, touring, and closing AnVIL platforms
 
 ## Video overview on using Jupyter Notebooks 
 
+:::: {.borrowed_chunk}
 
 Here is a video tutorial that describes the basics of using Jupyter Notebook on AnVIL.
 
@@ -92,6 +93,7 @@ Note that, in order to use Jupyter, you must have access to a Terra Workspace wi
 
 ## Video overview on using Galaxy
 
+:::: {.borrowed_chunk}
 
 Here is a video tutorial that describes the basics of using Galaxy on AnVIL.
 
@@ -106,6 +108,7 @@ Here is a video tutorial that describes the basics of using Galaxy on AnVIL.
 ### Slides
 
 The slides for this tutorial are are located [here](https://docs.google.com/presentation/d/1yYCg4cPVBMMDghT17B4XzROieqyMH99Ex9nMm_Scm9Q).
+::::
 
 ## Starting Galaxy
 
@@ -156,6 +159,7 @@ Finally, select “Delete everything, including persistent disk”. Make sure yo
 
 ## Video overview on using RStudio
 
+:::: {.borrowed_chunk}
 
 Here is a video tutorial that describes the basics of using RStudio on AnVIL.
 
@@ -170,6 +174,7 @@ Here is a video tutorial that describes the basics of using RStudio on AnVIL.
 ### Slides
 
 The slides for this tutorial are are located [here](https://docs.google.com/presentation/d/1eypYLLqD11-NwHLs4adGpcuSB07dYEJfAaALSMvgzqw).
+::::
 
 ## Launching RStudio
 
@@ -336,3 +341,49 @@ You can also pause your cloud environment(s) at https://anvil.terra.bio/#cluster
 You can also delete your cloud environment(s) and disk storage at https://anvil.terra.bio/#clusters.
 :::
 ::::
+
+## Pausing vs. Deleting cloud environments
+
+These instructions can be customized to a specific cloud environment by setting `AnVIL_module_settings$cloud_environment` before running `cow::borrow_chapter()`.  If these variables have not been set, it defaults to "your cloud environment".
+
+### Generic cloud environment
+
+:::: {.borrowed_chunk}
+
+Cloud computing costs are based on the amount of time you use the computing resources, so it's important to clean up after yourself when you're done, and not just leave the computers running.
+
+There are two ways to "shut down" your cloud environment on AnVIL:
+
+- **Pause** the environment: This will save a copy of your work, and then release the computers for other people to use them.  **Do this if you plan to continue working in your cloud environment**.
+    - It's similar to turning off your computer or phone - when you start it back up, everything will be where you left it.
+    - This still costs a small amount of money, but much less than leaving the computer running.  
+- **Delete** the environment: This will delete everything and then release the computers for other people to use them.  **Do this if you are completely finished working**, or if your future work will be in a new environment.
+    - It's similar to throwing your computer or phone in the trash!
+    - **You will not be able to recover your work.**
+    - Make sure you have saved anything you need to another location (such as the Workspace bucket, GitHub, or your local machine) before you delete your environment.
+::::
+
+### RStudio
+
+```
+AnVIL_module_settings <- list(cloud_environment = "RStudio")
+cow::borrow_chapter(
+  doc_path = "child/_child_cloud_environment_pause_vs_delete.Rmd",
+  repo_name = "jhudsl/AnVIL_Template"
+)
+```
+
+:::: {.borrowed_chunk}
+
+Cloud computing costs are based on the amount of time you use the computing resources, so it's important to clean up after yourself when you're done, and not just leave the computers running.
+
+There are two ways to "shut down" RStudio on AnVIL:
+
+- **Pause** the environment: This will save a copy of your work, and then release the computers for other people to use them.  **Do this if you plan to continue working in RStudio**.
+    - It's similar to turning off your computer or phone - when you start it back up, everything will be where you left it.
+    - This still costs a small amount of money, but much less than leaving the computer running.  
+- **Delete** the environment: This will delete everything and then release the computers for other people to use them.  **Do this if you are completely finished working**, or if your future work will be in a new environment.
+    - It's similar to throwing your computer or phone in the trash!
+    - **You will not be able to recover your work.**
+    - Make sure you have saved anything you need to another location (such as the Workspace bucket, GitHub, or your local machine) before you delete your environment.
+::::
diff --git a/docs/404.html b/docs/404.html
@@ -237,23 +237,20 @@
 <li class="chapter" data-level="7.1.2" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#slides"><i class="fa fa-check"></i><b>7.1.2</b> Slides</a></li>
 </ul></li>
 <li class="chapter" data-level="7.2" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#launching-jupyter"><i class="fa fa-check"></i><b>7.2</b> Launching Jupyter</a></li>
-<li class="chapter" data-level="7.3" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#video-overview-on-using-galaxy"><i class="fa fa-check"></i><b>7.3</b> Video overview on using Galaxy</a>
-<ul>
-<li class="chapter" data-level="7.3.1" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#objectives-1"><i class="fa fa-check"></i><b>7.3.1</b> Objectives</a></li>
-<li class="chapter" data-level="7.3.2" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#slides-1"><i class="fa fa-check"></i><b>7.3.2</b> Slides</a></li>
-</ul></li>
+<li class="chapter" data-level="7.3" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#video-overview-on-using-galaxy"><i class="fa fa-check"></i><b>7.3</b> Video overview on using Galaxy</a></li>
 <li class="chapter" data-level="7.4" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#starting-galaxy"><i class="fa fa-check"></i><b>7.4</b> Starting Galaxy</a></li>
 <li class="chapter" data-level="7.5" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#navigating-galaxy"><i class="fa fa-check"></i><b>7.5</b> Navigating Galaxy</a></li>
 <li class="chapter" data-level="7.6" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#deleting-galaxy"><i class="fa fa-check"></i><b>7.6</b> Deleting Galaxy</a></li>
-<li class="chapter" data-level="7.7" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#video-overview-on-using-rstudio"><i class="fa fa-check"></i><b>7.7</b> Video overview on using RStudio</a>
-<ul>
-<li class="chapter" data-level="7.7.1" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#objectives-2"><i class="fa fa-check"></i><b>7.7.1</b> Objectives</a></li>
-<li class="chapter" data-level="7.7.2" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#slides-2"><i class="fa fa-check"></i><b>7.7.2</b> Slides</a></li>
-</ul></li>
+<li class="chapter" data-level="7.7" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#video-overview-on-using-rstudio"><i class="fa fa-check"></i><b>7.7</b> Video overview on using RStudio</a></li>
 <li class="chapter" data-level="7.8" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#launching-rstudio"><i class="fa fa-check"></i><b>7.8</b> Launching RStudio</a></li>
 <li class="chapter" data-level="7.9" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#touring-rstudio"><i class="fa fa-check"></i><b>7.9</b> Touring RStudio</a></li>
 <li class="chapter" data-level="7.10" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#pausing-rstudio"><i class="fa fa-check"></i><b>7.10</b> Pausing RStudio</a></li>
 <li class="chapter" data-level="7.11" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#deleting-rstudio"><i class="fa fa-check"></i><b>7.11</b> Deleting RStudio</a></li>
+<li class="chapter" data-level="7.12" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#pausing-vs.-deleting-cloud-environments"><i class="fa fa-check"></i><b>7.12</b> Pausing vs. Deleting cloud environments</a>
+<ul>
+<li class="chapter" data-level="7.12.1" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#generic-cloud-environment"><i class="fa fa-check"></i><b>7.12.1</b> Generic cloud environment</a></li>
+<li class="chapter" data-level="7.12.2" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#rstudio"><i class="fa fa-check"></i><b>7.12.2</b> RStudio</a></li>
+</ul></li>
 </ul></li>
 <li class="chapter" data-level="8" data-path="student-instructions.html"><a href="student-instructions.html"><i class="fa fa-check"></i><b>8</b> Student instructions</a>
 <ul>

diff --git a/docs/a-new-chapter.html b/docs/a-new-chapter.html
@@ -237,23 +237,20 @@
 <li class="chapter" data-level="7.1.2" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#slides"><i class="fa fa-check"></i><b>7.1.2</b> Slides</a></li>
 </ul></li>
 <li class="chapter" data-level="7.2" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#launching-jupyter"><i class="fa fa-check"></i><b>7.2</b> Launching Jupyter</a></li>
-<li class="chapter" data-level="7.3" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#video-overview-on-using-galaxy"><i class="fa fa-check"></i><b>7.3</b> Video overview on using Galaxy</a>
-<ul>
-<li class="chapter" data-level="7.3.1" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#objectives-1"><i class="fa fa-check"></i><b>7.3.1</b> Objectives</a></li>
-<li class="chapter" data-level="7.3.2" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#slides-1"><i class="fa fa-check"></i><b>7.3.2</b> Slides</a></li>
-</ul></li>
+<li class="chapter" data-level="7.3" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#video-overview-on-using-galaxy"><i class="fa fa-check"></i><b>7.3</b> Video overview on using Galaxy</a></li>
 <li class="chapter" data-level="7.4" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#starting-galaxy"><i class="fa fa-check"></i><b>7.4</b> Starting Galaxy</a></li>
 <li class="chapter" data-level="7.5" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#navigating-galaxy"><i class="fa fa-check"></i><b>7.5</b> Navigating Galaxy</a></li>
 <li class="chapter" data-level="7.6" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#deleting-galaxy"><i class="fa fa-check"></i><b>7.6</b> Deleting Galaxy</a></li>
-<li class="chapter" data-level="7.7" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#video-overview-on-using-rstudio"><i class="fa fa-check"></i><b>7.7</b> Video overview on using RStudio</a>
-<ul>
-<li class="chapter" data-level="7.7.1" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#objectives-2"><i class="fa fa-check"></i><b>7.7.1</b> Objectives</a></li>
-<li class="chapter" data-level="7.7.2" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#slides-2"><i class="fa fa-check"></i><b>7.7.2</b> Slides</a></li>
-</ul></li>
+<li class="chapter" data-level="7.7" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#video-overview-on-using-rstudio"><i class="fa fa-check"></i><b>7.7</b> Video overview on using RStudio</a></li>
 <li class="chapter" data-level="7.8" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#launching-rstudio"><i class="fa fa-check"></i><b>7.8</b> Launching RStudio</a></li>
 <li class="chapter" data-level="7.9" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#touring-rstudio"><i class="fa fa-check"></i><b>7.9</b> Touring RStudio</a></li>
 <li class="chapter" data-level="7.10" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#pausing-rstudio"><i class="fa fa-check"></i><b>7.10</b> Pausing RStudio</a></li>
 <li class="chapter" data-level="7.11" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#deleting-rstudio"><i class="fa fa-check"></i><b>7.11</b> Deleting RStudio</a></li>
+<li class="chapter" data-level="7.12" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#pausing-vs.-deleting-cloud-environments"><i class="fa fa-check"></i><b>7.12</b> Pausing vs. Deleting cloud environments</a>
+<ul>
+<li class="chapter" data-level="7.12.1" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#generic-cloud-environment"><i class="fa fa-check"></i><b>7.12.1</b> Generic cloud environment</a></li>
+<li class="chapter" data-level="7.12.2" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#rstudio"><i class="fa fa-check"></i><b>7.12.2</b> RStudio</a></li>
+</ul></li>
 </ul></li>
 <li class="chapter" data-level="8" data-path="student-instructions.html"><a href="student-instructions.html"><i class="fa fa-check"></i><b>8</b> Student instructions</a>
 <ul>

diff --git a/docs/about-the-authors.html b/docs/about-the-authors.html
@@ -237,23 +237,20 @@
 <li class="chapter" data-level="7.1.2" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#slides"><i class="fa fa-check"></i><b>7.1.2</b> Slides</a></li>
 </ul></li>
 <li class="chapter" data-level="7.2" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#launching-jupyter"><i class="fa fa-check"></i><b>7.2</b> Launching Jupyter</a></li>
-<li class="chapter" data-level="7.3" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#video-overview-on-using-galaxy"><i class="fa fa-check"></i><b>7.3</b> Video overview on using Galaxy</a>
-<ul>
-<li class="chapter" data-level="7.3.1" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#objectives-1"><i class="fa fa-check"></i><b>7.3.1</b> Objectives</a></li>
-<li class="chapter" data-level="7.3.2" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#slides-1"><i class="fa fa-check"></i><b>7.3.2</b> Slides</a></li>
-</ul></li>
+<li class="chapter" data-level="7.3" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#video-overview-on-using-galaxy"><i class="fa fa-check"></i><b>7.3</b> Video overview on using Galaxy</a></li>
 <li class="chapter" data-level="7.4" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#starting-galaxy"><i class="fa fa-check"></i><b>7.4</b> Starting Galaxy</a></li>
 <li class="chapter" data-level="7.5" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#navigating-galaxy"><i class="fa fa-check"></i><b>7.5</b> Navigating Galaxy</a></li>
 <li class="chapter" data-level="7.6" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#deleting-galaxy"><i class="fa fa-check"></i><b>7.6</b> Deleting Galaxy</a></li>
-<li class="chapter" data-level="7.7" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#video-overview-on-using-rstudio"><i class="fa fa-check"></i><b>7.7</b> Video overview on using RStudio</a>
-<ul>
-<li class="chapter" data-level="7.7.1" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#objectives-2"><i class="fa fa-check"></i><b>7.7.1</b> Objectives</a></li>
-<li class="chapter" data-level="7.7.2" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#slides-2"><i class="fa fa-check"></i><b>7.7.2</b> Slides</a></li>
-</ul></li>
+<li class="chapter" data-level="7.7" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#video-overview-on-using-rstudio"><i class="fa fa-check"></i><b>7.7</b> Video overview on using RStudio</a></li>
 <li class="chapter" data-level="7.8" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#launching-rstudio"><i class="fa fa-check"></i><b>7.8</b> Launching RStudio</a></li>
 <li class="chapter" data-level="7.9" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#touring-rstudio"><i class="fa fa-check"></i><b>7.9</b> Touring RStudio</a></li>
 <li class="chapter" data-level="7.10" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#pausing-rstudio"><i class="fa fa-check"></i><b>7.10</b> Pausing RStudio</a></li>
 <li class="chapter" data-level="7.11" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#deleting-rstudio"><i class="fa fa-check"></i><b>7.11</b> Deleting RStudio</a></li>
+<li class="chapter" data-level="7.12" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#pausing-vs.-deleting-cloud-environments"><i class="fa fa-check"></i><b>7.12</b> Pausing vs. Deleting cloud environments</a>
+<ul>
+<li class="chapter" data-level="7.12.1" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#generic-cloud-environment"><i class="fa fa-check"></i><b>7.12.1</b> Generic cloud environment</a></li>
+<li class="chapter" data-level="7.12.2" data-path="using-programming-platforms-on-anvil.html"><a href="using-programming-platforms-on-anvil.html#rstudio"><i class="fa fa-check"></i><b>7.12.2</b> RStudio</a></li>
+</ul></li>
 </ul></li>
 <li class="chapter" data-level="8" data-path="student-instructions.html"><a href="student-instructions.html"><i class="fa fa-check"></i><b>8</b> Student instructions</a>
 <ul>