Skip to content

Commit

Permalink
deleting template references page
Browse files Browse the repository at this point in the history
  • Loading branch information
jq-11 committed Dec 4, 2024
1 parent 68da13f commit 70ba60a
Show file tree
Hide file tree
Showing 15 changed files with 21 additions and 119 deletions.
Binary file modified .DS_Store
Binary file not shown.
28 changes: 0 additions & 28 deletions 013-TEMPLATE-REFERENCES.Rmd

This file was deleted.

20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,28 @@

This is the bookdown template for a standard CBW workshop.

## Understanding How to Understand and Fill in this Template

### Comments

Notes:

<!--- comment ---> is the notation for making a comment in a .R/md file. The comment begins after <!--- and ends after the FIRST ---> symbols.

<!-- This is a comment. --> Some explanations for in template will be in these comments.

You can instantly make a comment by clicking on the line with the text you want to comment and using the keyboard command: `cmd/ctrl` + `shift` + `c`.

### Content in Square Brackets

Content that you shoulgid replace is written in square brackets [insert here].

*Currently a work-in-progress.*

Development Notes:
# Development Notes:
- Michelle + Nia can update the photos if they want, they're in img/faculty/. (I just took these off the internet, quality might be bad)
- update favicon.ico with one with highter quality
- in the upper right corner, there is twitter/facebook/other sharing links, they are based on the
index.Rmd HTML metadata ? - not that important, we can care about this later

BUGS:

- figure out good naming convention for files
Binary file modified _main_files/figure-latex/pressure-plot-1.pdf
Binary file not shown.
6 changes: 0 additions & 6 deletions docs/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -153,12 +153,6 @@
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#nia-hughes-sheher"><i class="fa fa-check"></i>Nia Hughes (she/her)</a></li>
</ul></li>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#class-photo"><i class="fa fa-check"></i>Class Photo</a></li>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#template-references"><i class="fa fa-check"></i>TEMPLATE-REFERENCES</a>
<ul>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#comments"><i class="fa fa-check"></i>Comments</a></li>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#content-in-square-brackets"><i class="fa fa-check"></i>Content in Square Brackets</a></li>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#quick-formatting"><i class="fa fa-check"></i>Quick Formatting</a></li>
</ul></li>
</ul></li>
<li class="part"><span><b>II Modules</b></span></li>
<li class="chapter" data-level="" data-path="module-1.html"><a href="module-1.html"><i class="fa fa-check"></i>Module 1</a>
Expand Down
Binary file modified docs/_main.epub
Binary file not shown.
Binary file modified docs/_main.pdf
Binary file not shown.
27 changes: 0 additions & 27 deletions docs/_main.tex
Original file line number Diff line number Diff line change
Expand Up @@ -205,33 +205,6 @@ \section{Class Photo}\label{class-photo}

\textless- Replace the file address to your actual class photo file location

\section{TEMPLATE-REFERENCES}\label{template-references}

Everything below will hopefully help you create a workshop website and understand how to work with this template.

\subsection{Comments}\label{comments}

Notes:

is the notation for making a comment in a .R/md file. The comment begins after symbols.

Some explanations for this template will be in these comments.

You can instantly make a comment by clicking on the line with the text you want to comment and using the keyboard command: \texttt{cmd/ctrl} + \texttt{shift} + \texttt{c}.

\subsection{Content in Square Brackets}\label{content-in-square-brackets}

Content that you should replace is written in square brackets {[}insert here{]}.

\subsection{Quick Formatting}\label{quick-formatting}

Copy and paste the below formatting into your files!

Create a callout
\textgreater{} Callout
\textgreater{}
\textgreater{} callout

\part{Modules}\label{part-modules}

\chapter{Module 1}\label{module-1}
Expand Down
32 changes: 0 additions & 32 deletions docs/course-schedule.html
Original file line number Diff line number Diff line change
Expand Up @@ -153,12 +153,6 @@
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#nia-hughes-sheher"><i class="fa fa-check"></i>Nia Hughes (she/her)</a></li>
</ul></li>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#class-photo"><i class="fa fa-check"></i>Class Photo</a></li>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#template-references"><i class="fa fa-check"></i>TEMPLATE-REFERENCES</a>
<ul>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#comments"><i class="fa fa-check"></i>Comments</a></li>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#content-in-square-brackets"><i class="fa fa-check"></i>Content in Square Brackets</a></li>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#quick-formatting"><i class="fa fa-check"></i>Quick Formatting</a></li>
</ul></li>
</ul></li>
<li class="part"><span><b>II Modules</b></span></li>
<li class="chapter" data-level="" data-path="module-1.html"><a href="module-1.html"><i class="fa fa-check"></i>Module 1</a>
Expand Down Expand Up @@ -265,32 +259,6 @@ <h2>Class Photo<a href="course-schedule.html#class-photo" class="anchor-section"
<!-- ![Class Photo](./img/class-photo.jpg) -->
<p>&lt;- Replace the file address to your actual class photo file location</p>

</div>
<div id="template-references" class="section level2 hasAnchor">
<h2>TEMPLATE-REFERENCES<a href="course-schedule.html#template-references" class="anchor-section" aria-label="Anchor link to header"></a></h2>
<p>Everything below will hopefully help you create a workshop website and understand how to work with this template.</p>
<div id="comments" class="section level3 hasAnchor">
<h3>Comments<a href="course-schedule.html#comments" class="anchor-section" aria-label="Anchor link to header"></a></h3>
<p>Notes:</p>
<!--- comment --->
<p>is the notation for making a comment in a .R/md file. The comment begins after <!--- and ends after the FIRST ---> symbols.</p>
<!-- This is a comment. -->
<p>Some explanations for this template will be in these comments.</p>
<p>You can instantly make a comment by clicking on the line with the text you want to comment and using the keyboard command: <code>cmd/ctrl</code> + <code>shift</code> + <code>c</code>.</p>
</div>
<div id="content-in-square-brackets" class="section level3 hasAnchor">
<h3>Content in Square Brackets<a href="course-schedule.html#content-in-square-brackets" class="anchor-section" aria-label="Anchor link to header"></a></h3>
<p>Content that you should replace is written in square brackets [insert here].</p>
</div>
<div id="quick-formatting" class="section level3 hasAnchor">
<h3>Quick Formatting<a href="course-schedule.html#quick-formatting" class="anchor-section" aria-label="Anchor link to header"></a></h3>
<p>Copy and paste the below formatting into your files!</p>
<p>Create a callout
&gt; Callout
&gt;
&gt; callout</p>

</div>
</div>
</div>

Expand Down
7 changes: 1 addition & 6 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -153,12 +153,6 @@
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#nia-hughes-sheher"><i class="fa fa-check"></i>Nia Hughes (she/her)</a></li>
</ul></li>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#class-photo"><i class="fa fa-check"></i>Class Photo</a></li>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#template-references"><i class="fa fa-check"></i>TEMPLATE-REFERENCES</a>
<ul>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#comments"><i class="fa fa-check"></i>Comments</a></li>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#content-in-square-brackets"><i class="fa fa-check"></i>Content in Square Brackets</a></li>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#quick-formatting"><i class="fa fa-check"></i>Quick Formatting</a></li>
</ul></li>
</ul></li>
<li class="part"><span><b>II Modules</b></span></li>
<li class="chapter" data-level="" data-path="module-1.html"><a href="module-1.html"><i class="fa fa-check"></i>Module 1</a>
Expand Down Expand Up @@ -211,6 +205,7 @@ <h1>Welcome<a href="index.html#welcome" class="anchor-section" aria-label="Ancho
<!-- This is your index.Rmd file. It is the mandatory landing page for your website. -->
<p>Put some introductory content here. (ex. links to bioinformatics.ca, general info)</p>
<!-- The rest of the content making up the welcome pages are in following files, which begin with "01#-description_of_file" -->
<!-- NOTE: Go to the README.md to help understand what to fill in for this workshop template! -->

</div>
</section>
Expand Down
6 changes: 0 additions & 6 deletions docs/module-1.html
Original file line number Diff line number Diff line change
Expand Up @@ -153,12 +153,6 @@
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#nia-hughes-sheher"><i class="fa fa-check"></i>Nia Hughes (she/her)</a></li>
</ul></li>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#class-photo"><i class="fa fa-check"></i>Class Photo</a></li>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#template-references"><i class="fa fa-check"></i>TEMPLATE-REFERENCES</a>
<ul>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#comments"><i class="fa fa-check"></i>Comments</a></li>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#content-in-square-brackets"><i class="fa fa-check"></i>Content in Square Brackets</a></li>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#quick-formatting"><i class="fa fa-check"></i>Quick Formatting</a></li>
</ul></li>
</ul></li>
<li class="part"><span><b>II Modules</b></span></li>
<li class="chapter" data-level="" data-path="module-1.html"><a href="module-1.html"><i class="fa fa-check"></i>Module 1</a>
Expand Down
6 changes: 0 additions & 6 deletions docs/module-2.html
Original file line number Diff line number Diff line change
Expand Up @@ -153,12 +153,6 @@
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#nia-hughes-sheher"><i class="fa fa-check"></i>Nia Hughes (she/her)</a></li>
</ul></li>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#class-photo"><i class="fa fa-check"></i>Class Photo</a></li>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#template-references"><i class="fa fa-check"></i>TEMPLATE-REFERENCES</a>
<ul>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#comments"><i class="fa fa-check"></i>Comments</a></li>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#content-in-square-brackets"><i class="fa fa-check"></i>Content in Square Brackets</a></li>
<li class="chapter" data-level="" data-path="course-schedule.html"><a href="course-schedule.html#quick-formatting"><i class="fa fa-check"></i>Quick Formatting</a></li>
</ul></li>
</ul></li>
<li class="part"><span><b>II Modules</b></span></li>
<li class="chapter" data-level="" data-path="module-1.html"><a href="module-1.html"><i class="fa fa-check"></i>Module 1</a>
Expand Down
4 changes: 0 additions & 4 deletions docs/reference-keys.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ instructor-ta
michelle-brazas-phd
nia-hughes-sheher
class-photo
template-references
comments
content-in-square-brackets
quick-formatting
module-1
lecture
downloads
Expand Down
2 changes: 1 addition & 1 deletion docs/search_index.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[["index.html", "[Name of Workshop][Year] Welcome", " [Name of Workshop][Year] Instructors: [list instructor names here] [Insert dates of the workshop] Welcome Welcome to CBW’s [workshop name, year] Workshop! Put some introductory content here. (ex. links to bioinformatics.ca, general info) "],["course-schedule.html", "Course Schedule Pre-workshop Materials Computing Setup &amp; Downloads Meet Your Faculty Class Photo TEMPLATE-REFERENCES", " Course Schedule Copy paste a table into https://www.tablesgenerator.com/markdown_tables (select convert to markdown) to create a table in markdown. Pre-workshop Materials Click here for your prework! Computing Setup &amp; Downloads Insert downloads (ex. datasets) or other tech instructions here (ex. AWS Instructions) Meet Your Faculty Here’s your team! Instructor, TA, … Job Title Company/University/… Location — contact information [insert description of the person] Michelle Brazas, PhD Scientific Director Canadian Bioinformatics Workshops (CBW) Toronto, ON, CA — [email protected] Dr. Michelle Brazas is the Associate Director for Adaptive Oncology at the Ontario Institute for Cancer Research (OICR), and acting Scientific Director at Bioinformatics.ca. Previously, Dr. Brazas was the Program Manager for Bioinformatics.ca and a faculty member in Biotechnology at BCIT. Michelle co-founded and runs the Toronto Bioinformatics User Group (TorBUG) now in its 11th season, and plays an active role in the International Society of Computational Biology where she sits on the Board of Directors and Executive Board. Nia Hughes (she/her) Program Manager, Bioinformatics.ca Ontario Institute for Cancer Research Toronto, ON, Canada — [email protected] Nia is the Program Manager for Bioinformatics.ca, where she coordinates the Canadian Bioinformatics Workshop Series. Prior to starting at OICR, she completed her M.Sc. in Bioinformatics from the University of Guelph in 2020 before working there as a bioinformatician studying epigenetic and transcriptomic patterns across maize varieties. Class Photo &lt;- Replace the file address to your actual class photo file location TEMPLATE-REFERENCES Everything below will hopefully help you create a workshop website and understand how to work with this template. Comments Notes: is the notation for making a comment in a .R/md file. The comment begins after symbols. Some explanations for this template will be in these comments. You can instantly make a comment by clicking on the line with the text you want to comment and using the keyboard command: cmd/ctrl + shift + c. Content in Square Brackets Content that you should replace is written in square brackets [insert here]. Quick Formatting Copy and paste the below formatting into your files! Create a callout &gt; Callout &gt; &gt; callout "],["module-1.html", "Module 1 Lecture Lab", " Module 1 Welcome to module 1! Lecture Here is an example of a pdf embedded:   Here is an example of a YouTube video embedded: ^ HEIGHT HAS A BUG Downloads [insert your downloads for this module here (ex. datasets)] Lab [Your lab here] # Your R code here # For example: x &lt;- 42 x ## [1] 42 # Your python code here # For example: print(&quot;hello world&quot;) ## hello world # Your bash code here # For example: pwd ## /Users/jqiu/Documents/CBWgithub/cbw-dev-templates-docs/bookdown-template Try running these code “chunks” by pressing the green (left-pointing) triangle next to your code chunks. You will see the code run in the console and the output provided below the code chunk. The output of the code will also be produced under the code chunk on your website page. "],["module-2.html", "Module 2 Lecture Lab", " Module 2 Lecture Lab put some example of producing images, show chunk options include formatting options "],["404.html", "Error 404: This page does not exist.", " Error 404: This page does not exist. This page does not exist anymore! Try going back to the workshop homepage or the bioinformatics.ca homepage. You must update these pages for new workshops. "]]
[["index.html", "[Name of Workshop][Year] Welcome", " [Name of Workshop][Year] Instructors: [list instructor names here] [Insert dates of the workshop] Welcome Welcome to CBW’s [workshop name, year] Workshop! Put some introductory content here. (ex. links to bioinformatics.ca, general info) "],["course-schedule.html", "Course Schedule Pre-workshop Materials Computing Setup &amp; Downloads Meet Your Faculty Class Photo", " Course Schedule Copy paste a table into https://www.tablesgenerator.com/markdown_tables (select convert to markdown) to create a table in markdown. Pre-workshop Materials Click here for your prework! Computing Setup &amp; Downloads Insert downloads (ex. datasets) or other tech instructions here (ex. AWS Instructions) Meet Your Faculty Here’s your team! Instructor, TA, … Job Title Company/University/… Location — contact information [insert description of the person] Michelle Brazas, PhD Scientific Director Canadian Bioinformatics Workshops (CBW) Toronto, ON, CA — [email protected] Dr. Michelle Brazas is the Associate Director for Adaptive Oncology at the Ontario Institute for Cancer Research (OICR), and acting Scientific Director at Bioinformatics.ca. Previously, Dr. Brazas was the Program Manager for Bioinformatics.ca and a faculty member in Biotechnology at BCIT. Michelle co-founded and runs the Toronto Bioinformatics User Group (TorBUG) now in its 11th season, and plays an active role in the International Society of Computational Biology where she sits on the Board of Directors and Executive Board. Nia Hughes (she/her) Program Manager, Bioinformatics.ca Ontario Institute for Cancer Research Toronto, ON, Canada — [email protected] Nia is the Program Manager for Bioinformatics.ca, where she coordinates the Canadian Bioinformatics Workshop Series. Prior to starting at OICR, she completed her M.Sc. in Bioinformatics from the University of Guelph in 2020 before working there as a bioinformatician studying epigenetic and transcriptomic patterns across maize varieties. Class Photo &lt;- Replace the file address to your actual class photo file location "],["module-1.html", "Module 1 Lecture Lab", " Module 1 Welcome to module 1! Lecture Here is an example of a pdf embedded:   Here is an example of a YouTube video embedded: ^ HEIGHT HAS A BUG Downloads [insert your downloads for this module here (ex. datasets)] Lab [Your lab here] # Your R code here # For example: x &lt;- 42 x ## [1] 42 # Your python code here # For example: print(&quot;hello world&quot;) ## hello world # Your bash code here # For example: pwd ## /Users/jqiu/Documents/CBWgithub/cbw-dev-templates-docs/bookdown-template Try running these code “chunks” by pressing the green (left-pointing) triangle next to your code chunks. You will see the code run in the console and the output provided below the code chunk. The output of the code will also be produced under the code chunk on your website page. "],["module-2.html", "Module 2 Lecture Lab", " Module 2 Lecture Lab put some example of producing images, show chunk options include formatting options "],["404.html", "Error 404: This page does not exist.", " Error 404: This page does not exist. This page does not exist anymore! Try going back to the workshop homepage or the bioinformatics.ca homepage. You must update these pages for new workshops. "]]
2 changes: 2 additions & 0 deletions index.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,5 @@ Welcome to CBW’s [workshop name, year] Workshop!
Put some introductory content here. (ex. links to bioinformatics.ca, general info)

<!-- The rest of the content making up the welcome pages are in following files, which begin with "01#-description_of_file" -->

<!-- NOTE: Go to the README.md to help understand what to fill in for this workshop template! -->

0 comments on commit 70ba60a

Please sign in to comment.