Skip to content

Commit

Permalink
Setting up the quarto book report
Browse files Browse the repository at this point in the history
  • Loading branch information
CarissaGervasi-NOAA committed Feb 6, 2024
1 parent 9c71d60 commit aa67928
Show file tree
Hide file tree
Showing 31 changed files with 73 additions and 2,115 deletions.
2 changes: 1 addition & 1 deletion .quarto/cites/index.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"index.qmd":[],"OA.qmd":[],"Lab-report\\OA.qmd":[]}
{"Lab-report\\OA.qmd":[],"index.qmd":[],"OA.qmd":[]}
2 changes: 1 addition & 1 deletion .quarto/xref/40871caf
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"headings":["esr-lab-reports","caribbean-esr","some-notes"],"options":{"chapters":true},"entries":[]}
{"options":{"chapters":true},"entries":[],"headings":["esr-lab-reports","caribbean-esr","some-notes"]}
13 changes: 13 additions & 0 deletions Caribbean-ESR.Rproj
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Version: 1.0

RestoreWorkspace: Default
SaveWorkspace: Default
AlwaysSaveHistory: Default

EnableCodeIndexing: Yes
UseSpacesForTab: Yes
NumSpacesForTab: 2
Encoding: UTF-8

RnwWeave: Sweave
LaTeX: pdfLaTeX
Binary file removed OA_files/figure-html/unnamed-chunk-3-1.png
Binary file not shown.
File renamed without changes.
File renamed without changes
File renamed without changes.
177 changes: 21 additions & 156 deletions _book/index.html → Report_book_files/setting_up_ESR_report.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,8 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

<meta name="author" content="Carissa Gervasi">
<meta name="dcterms.date" content="2024-02-06">

<title>Caribbean ESR Lab Report</title>
<title>setting_up_ESR_report</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
Expand All @@ -25,185 +23,61 @@
</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>
<script src="site_libs/quarto-search/autocomplete.umd.js"></script>
<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="./Lab-report/OA.html" rel="next">
<script src="site_libs/quarto-html/quarto.js"></script>
<script src="site_libs/quarto-html/popper.min.js"></script>
<script src="site_libs/quarto-html/tippy.umd.min.js"></script>
<script src="site_libs/quarto-html/anchor.min.js"></script>
<link href="site_libs/quarto-html/tippy.css" rel="stylesheet">
<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">{
"location": "sidebar",
"copy-button": false,
"collapse-after": 3,
"panel-placement": "start",
"type": "textbox",
"limit": 20,
"language": {
"search-no-results-text": "No results",
"search-matching-documents-text": "matching documents",
"search-copy-link-title": "Copy link to search",
"search-hide-matches-text": "Hide additional matches",
"search-more-match-text": "more match in this document",
"search-more-matches-text": "more matches in this document",
"search-clear-button-title": "Clear",
"search-detached-cancel-button-title": "Cancel",
"search-submit-button-title": "Submit",
"search-label": "Search"
}
}</script>
<script src="setting_up_ESR_report_files/libs/clipboard/clipboard.min.js"></script>
<script src="setting_up_ESR_report_files/libs/quarto-html/quarto.js"></script>
<script src="setting_up_ESR_report_files/libs/quarto-html/popper.min.js"></script>
<script src="setting_up_ESR_report_files/libs/quarto-html/tippy.umd.min.js"></script>
<script src="setting_up_ESR_report_files/libs/quarto-html/anchor.min.js"></script>
<link href="setting_up_ESR_report_files/libs/quarto-html/tippy.css" rel="stylesheet">
<link href="setting_up_ESR_report_files/libs/quarto-html/quarto-syntax-highlighting.css" rel="stylesheet" id="quarto-text-highlighting-styles">
<script src="setting_up_ESR_report_files/libs/bootstrap/bootstrap.min.js"></script>
<link href="setting_up_ESR_report_files/libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
<link href="setting_up_ESR_report_files/libs/bootstrap/bootstrap.min.css" rel="stylesheet" id="quarto-bootstrap" data-mode="light">


</head>

<body class="nav-sidebar floating">
<body class="fullcontent">

<div id="quarto-content" class="page-columns page-rows-contents page-layout-article">

<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">
<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>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./index.html">Part 1: Intro</a></li><li class="breadcrumb-item"><a href="./index.html"><span class="chapter-number">1</span>&nbsp; <span class="chapter-title">ESR Lab Reports</span></a></li></ol></nav>
<a class="flex-grow-1" role="button" 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(); }">
</a>
<button type="button" class="btn quarto-search-button" aria-label="" onclick="window.quartoOpenSearch();">
<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">
<!-- sidebar -->
<nav id="quarto-sidebar" class="sidebar collapse collapse-horizontal sidebar-navigation floating overflow-auto">
<div class="pt-lg-2 mt-2 text-left sidebar-header">
<div class="sidebar-title mb-0 py-0">
<a href="./">Caribbean ESR Lab Report</a>
</div>
</div>
<div class="mt-2 flex-shrink-0 align-items-center">
<div class="sidebar-search">
<div id="quarto-search" class="" title="Search"></div>
</div>
</div>
<div class="sidebar-menu-container">
<ul class="list-unstyled mt-1">
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" aria-expanded="true">
<span class="menu-text">Part 1: Intro</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./index.html" class="sidebar-item-text sidebar-link active"><span class="chapter-title">ESR Lab Reports</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" aria-expanded="true">
<span class="menu-text">Part 2: Indicators</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-2" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./Lab-report/OA.html" class="sidebar-item-text sidebar-link"><span class="chapter-title">Ocean acidification indicator</span></a>
</div>
</li>
</ul>
</li>
</ul>
</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="#esr-lab-reports" id="toc-esr-lab-reports" class="nav-link active" data-scroll-target="#esr-lab-reports">ESR Lab Reports</a></li>
<li><a href="#caribbean-esr" id="toc-caribbean-esr" class="nav-link" data-scroll-target="#caribbean-esr">Caribbean ESR</a></li>
<li><a href="#some-notes" id="toc-some-notes" class="nav-link" data-scroll-target="#some-notes">Some notes</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">Caribbean ESR Lab Report</h1>
<h1 class="title">setting_up_ESR_report</h1>
</div>



<div class="quarto-title-meta">

<div>
<div class="quarto-title-meta-heading">Author</div>
<div class="quarto-title-meta-contents">
<p>Carissa Gervasi </p>
</div>
</div>

<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">February 6, 2024</p>
</div>
</div>


</div>


</header>

<section id="esr-lab-reports" class="level2">
<h2 class="anchored" data-anchor-id="esr-lab-reports">ESR Lab Reports</h2>
<p>ESR lab reports are quarto books that compile the R scripts for each indicator as well as any other descriptions of how the ESR will be put together.</p>
</section>
<section id="caribbean-esr" class="level2">
<h2 class="anchored" data-anchor-id="caribbean-esr">Caribbean ESR</h2>
<p>This lab report is for the Caribbean ESR that was compiled from 2023-2024. This is the first ESR for the Caribbean region. Here we can add more text about why this ESR is being compiled.</p>
<p>This report is for the Caribbean ESR that was compiled from 2023-2024. This is the first ESR for the Caribbean region. Here we can add more text about why this ESR is being compiled.</p>
</section>
<section id="some-notes" class="level2">
<h2 class="anchored" data-anchor-id="some-notes">Some notes</h2>
<p>This lab report was created the following way:</p>
<p>The Caribbean ESR report was created the following way:</p>
<ol type="1">
<li>clone the Caribbean ESR repo into my R studio</li>
<li>create a new folder in the repo called “Lab report”</li>
<li>create 2 files, one called “index.qmd” and abother called “_quarto.txt” within the Lab report folder</li>
<li>create 2 files, one called “index.qmd” and another called “_quarto.txt” in the main Caribbean ESR folder</li>
<li>rename the “_quarto.txt” file to “_quarto.yml” in file explorer to change it into the book YAML</li>
<li>populate the YAML document</li>
<li>Now in order to be able to render the book as both an html and pdf (or whatever other format you want) you need to make sure all the appropriate files are in the Lab report folder. I needed to move the Caribbean-ESR.Rproj file, the .git folder, and the .gitignore files into the Lab report folder from the main Caribbean-ESR folder.</li>
<li>Now in order to be able to render the book as both an html and pdf (or whatever other format you want) you need to make sure all the appropriate files are in the main folder. You can’t put them in sub-fold</li>
</ol>


</section>

</main> <!-- /main -->
</main>
<!-- /main column -->
<script id="quarto-html-after-body" type="application/javascript">
window.document.addEventListener("DOMContentLoaded", function (event) {
const toggleBodyColorMode = (bsSheetEl) => {
Expand Down Expand Up @@ -437,15 +311,6 @@ <h2 class="anchored" data-anchor-id="some-notes">Some notes</h2>
}
});
</script>
<nav class="page-navigation">
<div class="nav-page nav-page-previous">
</div>
<div class="nav-page nav-page-next">
<a href="./Lab-report/OA.html" class="pagination-link">
<span class="nav-page-text"><span class="chapter-title">Ocean acidification indicator</span></span> <i class="bi bi-arrow-right-short"></i>
</a>
</div>
</nav>
</div> <!-- /content -->


Expand Down
19 changes: 19 additions & 0 deletions Report_book_files/setting_up_ESR_report.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: "setting_up_ESR_report"
format: html
editor: visual
---

## Caribbean ESR

This report is for the Caribbean ESR that was compiled from 2023-2024. This is the first ESR for the Caribbean region. Here we can add more text about why this ESR is being compiled.

## Some notes

The Caribbean ESR report was created the following way:

1. clone the Caribbean ESR repo into my R studio
2. create 2 files, one called "index.qmd" and another called "\_quarto.txt" in the main Caribbean ESR folder
3. rename the "\_quarto.txt" file to "\_quarto.yml" in file explorer to change it into the book YAML
4. populate the YAML document
5. Now in order to be able to render the book as both an html and pdf (or whatever other format you want) you need to make sure all the appropriate files are in the main folder. You can't put them in sub-fold

Large diffs are not rendered by default.

File renamed without changes.
Loading

0 comments on commit aa67928

Please sign in to comment.