Skip to content

Commit

Permalink
added note for sucsess at end
Browse files Browse the repository at this point in the history
  • Loading branch information
ttimbers committed Feb 13, 2024
1 parent 1e5c8c8 commit 0dfec06
Show file tree
Hide file tree
Showing 12 changed files with 101 additions and 3 deletions.
18 changes: 18 additions & 0 deletions docs/_sources/materials/lectures/08-reproducible-reports.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -547,6 +547,24 @@
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## A helpful hint for successfully working with R Markdown documents\n",
"\n",
"Given that you need to render the entire document to see your Markdown and LaTeX rendered,\n",
"it is important to render often as you make changes.\n",
"If you make an error in a LaTeX equation for example,\n",
"it will stop the rendering process\n",
"and you will not get to see the rendered document.\n",
"So by rendering often\n",
"you will know where the last changes you made are\n",
"and then will be able to easily identify and fix your errors."
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": []
}
],
Expand Down
13 changes: 13 additions & 0 deletions docs/materials/lectures/08-reproducible-reports.html
Original file line number Diff line number Diff line change
Expand Up @@ -422,6 +422,7 @@ <h2> Contents </h2>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#tables">Tables</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#inline-code">Inline code</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#code-chunk-execution-options">Code chunk execution options</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#a-helpful-hint-for-successfully-working-with-r-markdown-documents">A helpful hint for successfully working with R Markdown documents</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -902,6 +903,17 @@ <h2>Code chunk execution options<a class="headerlink" href="#code-chunk-executio
</pre></div>
</div>
</section>
<section id="a-helpful-hint-for-successfully-working-with-r-markdown-documents">
<h2>A helpful hint for successfully working with R Markdown documents<a class="headerlink" href="#a-helpful-hint-for-successfully-working-with-r-markdown-documents" title="Permalink to this heading">#</a></h2>
<p>Given that you need to render the entire document to see your Markdown and LaTeX rendered,
it is important to render often as you make changes.
If you make an error in a LaTeX equation for example,
it will stop the rendering process
and you will not get to see the rendered document.
So by rendering often
you will know where the last changes you made are
and then will be able to easily identify and fix your errors.</p>
</section>
</section>

<script type="text/x-thebe-config">
Expand Down Expand Up @@ -1002,6 +1014,7 @@ <h2>Code chunk execution options<a class="headerlink" href="#code-chunk-executio
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#tables">Tables</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#inline-code">Inline code</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#code-chunk-execution-options">Code chunk execution options</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#a-helpful-hint-for-successfully-working-with-r-markdown-documents">A helpful hint for successfully working with R Markdown documents</a></li>
</ul>
</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

Binary file modified materials/_build/.doctrees/environment.pickle
Binary file not shown.
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -547,6 +547,24 @@
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## A helpful hint for successfully working with R Markdown documents\n",
"\n",
"Given that you need to render the entire document to see your Markdown and LaTeX rendered,\n",
"it is important to render often as you make changes.\n",
"If you make an error in a LaTeX equation for example,\n",
"it will stop the rendering process\n",
"and you will not get to see the rendered document.\n",
"So by rendering often\n",
"you will know where the last changes you made are\n",
"and then will be able to easily identify and fix your errors."
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": []
}
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -422,6 +422,7 @@ <h2> Contents </h2>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#tables">Tables</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#inline-code">Inline code</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#code-chunk-execution-options">Code chunk execution options</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#a-helpful-hint-for-successfully-working-with-r-markdown-documents">A helpful hint for successfully working with R Markdown documents</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -902,6 +903,17 @@ <h2>Code chunk execution options<a class="headerlink" href="#code-chunk-executio
</pre></div>
</div>
</section>
<section id="a-helpful-hint-for-successfully-working-with-r-markdown-documents">
<h2>A helpful hint for successfully working with R Markdown documents<a class="headerlink" href="#a-helpful-hint-for-successfully-working-with-r-markdown-documents" title="Permalink to this heading">#</a></h2>
<p>Given that you need to render the entire document to see your Markdown and LaTeX rendered,
it is important to render often as you make changes.
If you make an error in a LaTeX equation for example,
it will stop the rendering process
and you will not get to see the rendered document.
So by rendering often
you will know where the last changes you made are
and then will be able to easily identify and fix your errors.</p>
</section>
</section>

<script type="text/x-thebe-config">
Expand Down Expand Up @@ -1002,6 +1014,7 @@ <h2>Code chunk execution options<a class="headerlink" href="#code-chunk-executio
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#tables">Tables</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#inline-code">Inline code</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#code-chunk-execution-options">Code chunk execution options</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#a-helpful-hint-for-successfully-working-with-r-markdown-documents">A helpful hint for successfully working with R Markdown documents</a></li>
</ul>
</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion materials/_build/html/searchindex.js

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -547,6 +547,24 @@
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## A helpful hint for successfully working with R Markdown documents\n",
"\n",
"Given that you need to render the entire document to see your Markdown and LaTeX rendered,\n",
"it is important to render often as you make changes.\n",
"If you make an error in a LaTeX equation for example,\n",
"it will stop the rendering process\n",
"and you will not get to see the rendered document.\n",
"So by rendering often\n",
"you will know where the last changes you made are\n",
"and then will be able to easily identify and fix your errors."
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": []
}
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@
" "
],
"text/plain": [
"<IPython.lib.display.YouTubeVideo at 0x10834b110>"
"<IPython.lib.display.YouTubeVideo at 0x1059b3290>"
]
},
"execution_count": 1,
Expand Down
18 changes: 18 additions & 0 deletions materials/materials/lectures/08-reproducible-reports.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -547,6 +547,24 @@
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## A helpful hint for successfully working with R Markdown documents\n",
"\n",
"Given that you need to render the entire document to see your Markdown and LaTeX rendered,\n",
"it is important to render often as you make changes.\n",
"If you make an error in a LaTeX equation for example,\n",
"it will stop the rendering process\n",
"and you will not get to see the rendered document.\n",
"So by rendering often\n",
"you will know where the last changes you made are\n",
"and then will be able to easily identify and fix your errors."
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": []
}
],
Expand Down

0 comments on commit 0dfec06

Please sign in to comment.